It's time to move your docs in the repo
a day ago
- #AI
- #documentation
- #version control
- AI makes it easier to keep documentation up to date when stored in the repository.
- Benefits of docs in the repo include version control, proximity to code, formal approval, automatic generation, testing, and efficient editing.
- AI agents increase the proportion of markdown files in commits, blurring the line between AI-only and human-only documentation.
- Engineers are shifting focus left, emphasizing the importance of specs and guidelines over code.
- AI agents solve stale docs by ensuring code and documentation alignment.
- Higher-level context from docs in the repo benefits AI agents.
- Materialized plans in the repo save time and tokens for future research.
- Objections to moving docs into the repo are addressed, emphasizing version control and review benefits.
- Non-engineers can access docs via internal websites, and there's a trend toward broader repo access.
- References and articles on documentation-driven development and technical documentation are provided.