A modern, open-source knowledge base for technical writers learning the Docs as Code methodology.
This project is a curated repository of technical writing standards, industry best practices, and infrastructure guides. It is built by a technical writer for technical writers—specifically those moving from traditional documentation tools to modern, developer-centric workflows.
The goal of this knowledge base is to bridge the gap between technical writing and engineering. It follows a learning-in-public model, documenting the transition from foundational writing mechanics to complex documentation infrastructure (API specs, CI/CD pipelines, and automated linting).
The content is organized into four strategic pillars:
- Technical writing: Foundational craft, including the 7 Cs, Plain Language, and UX writing.
- Documentation stack: The "technical" in technical writing (Git, SSGs, OpenAPI, and Markdown).
- Documentation lifecycle: The professional workflow (SDLC integration, SME interviews, and maintenance).
- Reference materials: Quick-lookup templates, glossaries, and industry standards (ISO/DITA).
This site is a living example of Docs as Code:
- Static Site Generator: Zensical
- Formatting: Extended Markdown (Admonitions, Mermaid.js, MathJax)
- Deployment: GitHub Pages
- Automation: GitHub Actions for automated builds and link checking.
To run this knowledge base on your local machine:
- Python 3.11+ installed on your system.
- A terminal or command prompt.
Zensical is a Python package. We recommend installing it within a virtual environment to keep your dependencies isolated.
macOS / Linux
# Create a virtual environment
python3 -m venv .venv
# Activate the environment
source .venv/bin/activate
# Install Zensical
pip install zensicalWindows
# Create a virtual environment
python -m venv .venv
# Activate the environment
.venv\Scripts\activate
# Install Zensical
pip install zensicalOnce installed, use the built-in preview server to view your changes in real-time:
zensical serveThe site will be available at http://localhost:8000.
As this is a community-focused resource, contributions are welcome!
- Report a Bug: Open an issue if you find broken links or outdated info.
- Request a Topic: If there's a gap in the KB, let me know.
- Submit a PR: See
CONTRIBUTING.md(coming soon) for style guidelines and pull request templates.
This project is licensed under the MIT License. Feel free to fork it and use it as a template for your own documentation projects.
Maintained by @vaishvanara