How to Create Great Personal Documentation
- id: 1709563577
- Date: March 4, 2024, 3:21 p.m.
- Author: Donald F. Elger
Definition (Great Personal Documentation System)
An great documentation system is defined as one that provides you with the best results with the fewest drawbacks and the most rewards.
How
Repeat the following actions. Every iteration cycle, drive up the quality.
Design your system. Or, improve your present system.
Apply your system. Concurrently, pay attention to what is working and what causes concerns.
Growth. By using reflective thinking, change your documentation system so you get better results, fewer drawbacks and more rewards.
Design
To design or improve your system take the following actions. Limit you time on this step to between 5 and 60 minutes.
Describe your present documentation system. Identify concerns.
Figure out the results you want, the drawbacks you wish to minimize, and the rewards you wish to optimize.
Figure out how to build or improve a documentation system:
Purpose: Figure out the most important reasons why documentation can benefit you.
Methods: List all possible methods of personal documentation and select those that are best for you.
Concept: Figure out how you will build your next iteration of document system.
Building: Build your system. Get the parts in place that you need.
Application
Use your system for your day to day work. Pay attention to what is working, what is not working, and concerns you have.
Growth
Take the following actions. Do this infrequently. Once per year if your documentation system is really good. Once per week if you are just starting out.
Strengths: List the practices and methods that are helping you get what you want out of your documentation system. Limit this to the three or four most useful actions.
Improvements: Figure out the most useful concern to address. Then figure out a future action to take and how to take this action. Limit this to one or two actions that will improve your system.
Insights. List the most important facts that you have learned about documentation during your last iteration cycle. Limit this between zero and three items.
Summary
Effective documentation (ED) refers to a system for documentation that gives you the best results with the fewest drawback.
The ED method involve three connected actions.
- Design: Figure out the best system for yourself.
- Present State: Prioritize strengths and improvement.
- Goal State: Describe the conditions of your improved documentation system.
- Method: List many methods and ideas for reaching your goal state. Select the best ones.
- Concept Design: