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: Writing a Developer's Guide From:"Dick Margulis " <margulis -at- mail -dot- fiam -dot- net> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Sat, 30 Nov 2002 10:10:02 -0500
Sarah,
I suggest you start with information that will help users localize their concern of the moment. In other words, begin with an overview of the system architecture (diagrams help), the general flow of transactions around the system, and a brief description of what each chunk of the system is and does. Key this overview to chapter numbers. Then, in each chapter, address one of the chunks you've identified--hardware, software, dataflow, interaction with other chunks.
That's how I've approached such systems in the past, and it has always been well received.
>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?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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
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!
---
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.
