TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Subject:Re: analyzing/mapping a process from a doc From:Keith Hood <klhra -at- yahoo -dot- com> To:Jay Maechtlen <techwriter -at- laserpubs -dot- com>, TechWrl list <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Wed, 11 May 2016 03:11:50 +0000 (UTC)
It would help if you posted some info on what types of documents they are - what kinds of topics they cover and the technology field(s) in which they apply.
Are the documents divided on the lines of user levels? That is, does a doc contain information for a user, and for an administrator? Or some other combination of user types? Splitting them along the lines of user type/level is a natural.
If you have a section that needs to be linked to appendices or other documents, a section where the information the user needs can't really be complete unless the user also reads the targeted document at the end of the link, that section sounds like a logical candidate to be split into its own document. It might work to actually incorporate a subset of the content in the targeted document into the body of the split-out section, rather than retain the link. That saves the reader from having to drill down farther - reducing the number of clicks needed to get all the information will make reading faster and the users will appreciate it.
On Friday, May 6, 2016 11:40 AM, Jay Maechtlen <techwriter -at- laserpubs -dot- com> wrote:
I'm not sure of terminology here-
We are publishing our docs on a SharePoint 'wiki', using Kaboodle to
translate from Word to the wiki.
There are some limitations on doc size and complexity, which are not
well defined.
Anyway - we have a few docs that are too long, and we'd like to refactor
or split them up into smaller chunks.
Can anyone suggest tricks/methods to analyze links and structure of a
doc or body of docs, to determine logical groupings and break points?
Thanks
Jay
--
Jay Maechtlen
626 444-5112 office
626 840-8875 cell
www.laserpubs.com
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Visit TechWhirl for the latest on content technology, content strategy and content development | http://techwhirl.com
Looking for articles on Technical Communications? Head over to our online magazine at http://techwhirl.com
Looking for the archived Techwr-l email discussions? Search our public email archives @ http://techwr-l.com/archives
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Visit TechWhirl for the latest on content technology, content strategy and content development | http://techwhirl.com