While many developers shy away from writing documentation, I find it to be an essential part of the development process. To me, a well-documented codebase is just as crucial as the code itself, serving as a narrative that explains what the code does and how it functions. My focus is always on creating documentation that is clear, concise, and practical. For this purpose, I frequently rely on Obsidian.md as my go-to tool.
When crafting documentation, I follow these key principles to ensure it’s as effective as possible:
- What does this documentation cover?
- Why is this information valuable?
- How can the reader implement or use this information?
- When should the reader refer to this documentation?
- Who is the intended audience for this documentation?
