Effective Documentation

Definition

Effective documentation is method for personal documentation that is defined by its actions and rewards.

Actions: The actions of the method include {describing a goal state, selecting the best mix of documentation tools, applying these tools, continually improving the system, and so forth}

Rewards: The rewards of the method include {more results and higher quality results, most important information is captured; captured information is easy to find, update, reorganize, and so forth; productivity is enhanced, and so forth}

Facts about Effective Documentation

  1. Why apply ED? Better results. More results. Peace of mind. Save huge amount of time. Clarity.

  2. How to apply ED? The method is explained in this note.

  3. When to apply ED? Use the method whenever documentation is worth doing; this is just about always.

  4. Who? Anybody can use this method. This method is especially good for professionals like engineers, scientists, mathematicians, teachers, programmers, and so forth.

  5. How Much? The amount of time to document is so tiny as to be negligible. The enhanced results and productivity make this value of this method well worth the effort that is needed to apply the method.