documentation

http://www.literateprogramming.com/documentation.pdf

 

We can generally say that the documentation produced falls into two

classes:
1. Process documentation
2. Product documentation

 

The IEEE standard for user documentation(IEEE, 2001) proposes that the

structure of a document should include the components shown in

Figure2.

 

However, many organizations will use the standard as a guide and will

not necessarily include all of the components shown in Figure2.

1. cover page which identifies the project, the document, the author,

the date of production, the type of document, configuration management

and quality assurance information, the intended recipients of the

documents, and the confidentiality class of the document, information

for document retrieval(an abstract or keywords) and a copyright

notice.
2. Document which are more than a few pages long should be divided

into chapters, consistent numbering...
3. If a document contains a lot of detailed, reference information it

should have an index.
4. If a document is intended for a wide spectrum of readers who may

have differing vocabularies, a glossary should be provided

 

저자는 아래 분류에 따른 standard를 제시한다.
Process standards
Product standards
Interchange standards

 

저자는 Writing style에 대해서 설명한다.
Technical writing is a craft rather than a science but some broad

guide-lines about how to write well areL