TECHNICAL DOCUMENTATION STANDARDS
Commenting Conventions
- Minimize the need for embedded comments by using the standard prologues, structured programming, good style, descriptive names, etc.
- Attach comments to block of code.
- Use problem domain terminology.
- Place to far right.
- Do not use long, involved comments.
- Be sure that comments, code, and specifications agree.
Hardware Documentation
- Internal Documentation
- Labels on packages, PC boards, connectors, chassis, etc.
- Color coded wires, parts, etc.