About
Document by Design
Why the 'by design'? Because random just doesn't cut it.
Documentation of any sort should be 'by design' for all the reasons inherent in its definition:
- Purposeful: to meet the user's need at the right time, in the right format, and with the right degree of detail.
- Planned: to meet a requirement using flexible but clear processes appropriate for the material and the development cycle.
- Intentional: to meet specific need, fill particular gaps, and provide directed reason for any activity.
Practical? to be sure documentation used to perform an action is concerned with the actual doing or use of something, rather than with just theory and ideas.
And pragmatic? one of my favorite words. It has many meanings, but they all acknowledge the importance of context and purpose for any action, including for the creation of the documentation...
|