Information Technology Reference
In-Depth Information
A.5 Final words of Documentation Guidelines
This guideline assumes that the reader is competent in basic grammar of English
language. I am giving the finer points of documenting requirements documents
correctly and facilitate identical interpretation of information presented. When we
document requirements in software engineering, one of the main objectives is to avoid
the possibility for confusion. We need to ensure that the reader would arrive at the same
interpretation as the writer intended. These guidelines are a step in that direction. Every
professional standards organization would have a documentation guideline and ensure
that all the documents released by them are conforming to that guideline. Software
organizations also produce a significant amount of documentation that would be
referred to by individuals other than the author. Therefore, it is essential for software
development organizations to have a documentation guideline. The guidelines
presented here may be used as they are or with modification.
Search WWH ::
Custom Search