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.
Hi Sarah
I recently experienced something like this.
I would suggest that you work hard on the TOC, meaning, spend a minimum of 1-2
months on finalizing this. (depends on how much time you have)
You can probably have a structure like this:
- Preface
- Introduction and Overview
- Before You Begin (This can have what you need to have installed, dependencies,
other hardware and software information etc.)
- Getting Started with xxx (how data flows around the system)
- Understanding xxx (architectural information)
- Code Descriptions
- other chapters
- ...
- ...
- Glossary
- Index
Hope this helps.
Regards
Neelam
"Payne, Sarah" wrote:
> Hi all,
>
> I have been tasked with writing a developer's guide for one of our internal
> systems. The system is large and complex and I'm a bit stumped as to how I
> should organise the information.
>
> I know that I need to include detailed code descriptions, architectural
> information, how data flows around the system and other hardware and
> software information. The guide is aimed at our developers and technical
> staff.
>
> How would you go about organising the information so that it is easy to find
> stuff?
>
> (I'm not having any problems with writing the content, just in finding a
> logical structure for it).
>
> Thanks in advance,
> Sarah
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Check out SnagIt - The Screen Capture Standard!
Download a free 30-day trial from http://www.techsmith.com/rdr/txt/twr
Find out what all the other tech writers, including Dan, already know!
Order RoboHelp X3 in November and receive $100 mail in rebate, FREE WebHelp
Merge Module and the new RoboPDF - add powerful PDF output functionality
to RoboHelp X3. Order online today at http://www.ehelp.com/techwr-l
---
You are currently subscribed to techwr-l as:
archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.
