This cheat sheet describes the idea of Documentation-as-Code and helps you to document your projects.
Falk Sippach
Challenges
- Existing documentation is cumbersome and outdated. How can you create and keep it current with your familiar tools?
- A picture is worth a thousand words. Which simple approaches and tools help you create effective diagrams?
- Docs-as-Code offers many tools, formats and best practices. How do you choose the right setup for your context?
- Over time, implementation and documentation tend to drift apart. How does the development team keep them aligned?
In this edition
- Documentation becomes an implementation concern
- Lower cognitive load with text-based formats
- Create concise, meaningful diagrams with lean tools
- Keep documentation continuously maintained
