RE: Writing for programmers

Subject: RE: Writing for programmers
From: "Mike West" <mwest -at- oz -dot- quest -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Thu, 13 Apr 2000 16:38:52 +1000

Shelley Hoose wrote:
>
>
> HI all,
>
> I've recently started a new job in which I am documenting software for
> programmers. It's Java with SQL Server at the back end. I don't really know
> anything about this stuff <snip>


Shelley,

You certainly have a difficult task ahead of you. I hope you have a
programming background of some kind. If not, you are in for a very hard slog.

You should look to systems development textbooks and reference books for
things like functional specs, ER diagrams, flowcharting, etc. Those are
system development tools, so you won't find much about them in Tech Comms
books, which focus more on the end-user materials. The standard system
development texts will cover the general topics. You might want to ask the
development manager, or a sympathetic developer, to recommend some books that
reflect the preferred methodology. Perhaps they can lend you their old
textbooks. Perhaps there are some development documents lying around from
previous projects that you can use as templates.

Good luck.

Michael West
Melbourne, Australia>





Previous by Author: RE: The garden PATH
Next by Author: XML Anyone?
Previous by Thread: Writing for programmers
Next by Thread: Re: Writing for Programmers


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


Sponsored Ads