Characteristics of good documentation
- All relevant information must be recorded.
- All paper records must be legible, signed and dated.
- Records must be contemporaneous, accurate and kept up to date.
- Records must be written in plain English avoiding jargon. (google)
My view:
- you must write to the language that readers understand
- you must speak simple, so all can understand
- if you use code must be accurate
- must exit an Outiline with links to chapters
- must review the document other Pro people
- it is good to have an Online copy
- and maybe more
