On 9/2/07, Dossy Shiobara <dossy -at- panoptic -dot- com> wrote:
> Are there software-oriented tech. writers who are also software
> engineers who can read through C source and write documentation
> based on what it does?
>
> The C code in question (AOLserver) is very clean, well-written and
> organized.
>
> Is there any hope in finding a tech. writer who has the necessary
> skills to help document such a project, or am I just dreaming?
That's not at all uncommon. I would think most software tech writers
have had to "use the source, Luke" at one time or another. I even
have some painfully clear memories of doing it with a couple of
large complex COBOL programs.
But it should generally be a last resort. First you read the specs,
the design docs, minutes from team meetings, ... assuming any of
those exist! (and if they don't, I for one will not believe your claim
that the code is well-written and well-organised) Then you play
with the product, test various things. You only look at code when
things are unclear after those.
--
Sandy Harris,
Nanjing, China
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more. http://www.DocToHelp.com/TechwrlList
True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-
