Document Notes Important for Maintenance [DI9] [WHY]
Tip DI9
There are often additional notes important for maintenance that don’t fall into other categories of data type overview documentation. These notes typically need to be used less frequently than kinds of overview documentation, so they are often best placed after other such documentation.
Design rationale is one of the most important aspects to comment on for maintenance programmers. Why was a data type designed the way it was? What were important design considerations/decisions made? Were there other designs explored but rejected? Get in the habit of documenting these things as soon as you think of them so that you don't forget.
Examples:
