blog: Documentation #32

New Issue

jeff · 2022-01-14T19:46:54Z

jeff commented

2022-01-14 19:46:54 +00:00

Documentation is a form of flushing out ideas (check your thoughts dir on this)
Manual for using

Creating documentation before work is not just to create a plan. It is to test your ideas. Documentation and planning are the cheapest times to make mistakes and learn. Diving into code, and finding out later there's an conceptual issue is expensive to fix.
This is essentially second order thinking: (1) I thought of an idea. (2) Let me think about this thought to see if it is valid.
Documentation smooths the ideas, which makes them faster. (Slow is smooth; smooth is fast.)

Do not create, test, fail, create in code when you can do it in thoughts for free.

“The palest ink is better than the best memory.” - Chinese proverb

Specificity creates clarity.

Documentation is the Maps in Maps of Meaning.

Documentation is a form of flushing out ideas (check your thoughts dir on this) Manual for using Creating documentation before work is not just to create a plan. It is to test your ideas. Documentation and planning are the cheapest times to make mistakes and learn. Diving into code, and finding out later there's an conceptual issue is expensive to fix. This is essentially second order thinking: (1) I thought of an idea. (2) Let me think about this thought to see if it is valid. Documentation smooths the ideas, which makes them faster. (Slow is smooth; smooth is fast.) Do not create, test, fail, create in code when you can do it in thoughts for free. “The palest ink is better than the best memory.” - Chinese proverb Specificity creates clarity. Documentation is the Maps in Maps of Meaning.

Sign in to join this conversation.