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.
Currently working on product where the only existing documentation is the Help and we're looking to single-source from FM. General procedure we have is OK:
Help (RH) > printed doc (Word) > FM
Fairly straightforward process (once styles are standardized) but have you any suggestions for how best to get the structure you want in FM?
Help topics > FM sections but as we all know Help isn't linear so while there is a 'flow' there's also assorted branches... Any suggestions as to how best to sort it out? I've done one small Help so far which was easy to work out but the next is going to be fun (Printed doc 600+ pages). I think I can break it down into what will be FM Chapters which helps but after that...
I've thought of doing a 'map' to show the flow with links shown as branches to the main flow... any thoughts /suggestions welcome.
Damien Braniff
Sr. Technical Writer
damienb -at- asg -dot- com<mailto:damienb -at- asg -dot- com>
Waterfront PLaza
8, Lagan Bank Road
Belfast, N. Ireland
BT1 3LR
Tel: +44 0 28.9072.3124
Fax: +44 0 28.9072.3324
www.asg.com<http://www.asg.com>
ASG-CloudFactory - The Single Solution to Build, Deploy & Manage your Cloud Environments
Click here for more information on the ASG-CloudFactory<http://www.asg.com/cloudfactory>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Create and publish documentation through multiple channels with Doc-To-Help. Choose your authoring formats and get any output you may need.
Try Doc-To-Help, now with MS SharePoint integration, free for 30-days.
