Docs as Code
Treat documentation like code: store in Git, review in pull requests, and deploy automatically. Learn the docs-as-code workflow with NeoArc Studio.
Docs-as-code is a philosophy that treats documentation with the same rigour as code. Store it in version control. Review changes in pull requests. Deploy automatically when changes merge. NeoArc Studio is built for this workflow, and this documentation site is maintained using these same practices.
Why Docs-as-Code?
Traditional documentation tools create separation between code and documentation:
The Workflow
Benefits
Documentation Never Drifts
When documentation updates are required as part of code changes, they happen at the same time. Reviewers catch missing documentation during code review.
Full Audit Trail
Git history shows every documentation change: who made it, when, what pull request it was part of, and what code changes it accompanied.
Easy Rollback
If a change introduces problems, roll back both code and documentation together. You never have mismatched versions.
Branching for Documentation
Work on documentation changes in isolation. Create a branch, get reviews, and resolve conflicts just like code.
Practical Tips
Review Documentation Like Code
When reviewing pull requests:
Use Pull Request Templates
Include documentation checkboxes in your PR templates:
## Checklist
- [ ] Updated relevant documentation
- [ ] Updated affected diagrams
- [ ] Added documentation for new features
- [ ] Reviewed by someone familiar with the area