Programmer Guide structure

Question

Hello,

I have to write a programmer guide. What is the general structure of the programmer guide?

Answer 1

I suggest you look at some other programming guides, see what they do and avoid. Read reviews on websites like Amazon and see what people recommend here, and for what reasons.

Answer 2

Here is a typical style the government uses. It is relatively straightforward to write manuals in this style. You get to decide what the section headings should be.

http://www.fhasecure.gov/offices/cio/sdm/devlife/tempchecks/umtemplate.doc