Docs-as-code
Updated: Thu Apr 17 2025
I use developer-focused tools like Markdown, Git, and VS Code to democratize content creation across your organization.
If you’re writing developer-focused (or generated) content, there’s a good chance you’re working in a docs-as-code environment. Docs-as-code typically uses these tools to auto-generate documentation:
- Some sort of version control, like GitLab, GitHub, or BitBucket.
- A text-based, unstructured language like Markdown, AsciiDoc, or reStructuredText. These languages are easy to learn, easy to write, and are extremely portable. The downsides are often a lack of structure and governance.
- Conversion to HTML and display in a browser. This can be roll-your-own, or incorporated into various services like a CMS, GitHub Pages, static site generators, or other processors.
Related
-
Pros and Cons of using Markdown for tech docs
panel discussion
Content Wrangler webcast, 2024
Tools
- GitHub/GitLab by GitHub/Microsoft
- Jira by Atlassian
- Nunjucks templating engine by Nunjucks
- VS Code by Microsoft