Writing a Developer's Guide

Subject: Writing a Developer's Guide
From: "Payne, Sarah" <sarah -dot- payne -at- eircom -dot- net>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Fri, 29 Nov 2002 14:35:14 -0000


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.



Previous by Author: Re: Repetition in Procedures
Next by Author: hard disk vs. hard drive
Previous by Thread: Re: U Attitude
Next by Thread: Re: Writing a Developer's Guide


What this post helpful? Share it with friends and colleagues:


Sponsored Ads