This is a growing collection of notes, insights, and experiments on technical writing in the docs-as-code ecosystem. Here, I explore tools, workflows, and best practices that bridge documentation and development - from version control and static site generators to continuous documentation and content automation.
👉 You can also visit my blog at https://v-schipka.github.io/ for more projects and writing.
Latest Updates
Recently Modified:
Recently Created:
- In-Product Learning
- Microbreaks for the Brain
- Documentation Laws
- Interactive Infographics
- Interactive Documentation
Content
List of notes in this vault.
Concepts
- arc42 Documentation Model
- 7 Action Model
- Code Documentation
- Digital Garden
- Cognitive Load Theory
- Documentation Laws
- CODEOWNERS
- Columbo Technique for Writers
- In-Product Learning
- Interactive Documentation
- Interactive Infographics
- Document Management Systems
- Documentation Platforms & Tools
- Documentation
- Microbreaks for the Brain
- Minimum Viable Docs
- Smart Information Maturity Models (SIMM)
- Job Titles
- LIFT Principle
- Top-Down vs Bottom-Up
- Topics
- Software Development Methodology
- Software Testing (ISTQB)
- SUI Graphics
- WYSIWYG
- Virtual Environments for Docs
- WYSIWYM
Conventions & Guidelines
- Feeding Chatbots
- Animations
- Video-Tutorials
- YOU in Documentation
- Placeholders
- Notes & Warning
- Screenshots
Help Authoring Tools
LLMs
Markup Languages
SaaS Documentation Platforms
Self-Hosted Wikis
SEO
Static Site Generators
- Antora
- Astro + Starlight
- Docusaurus
- MkDocs Plugins
- Hugo
- Quartz 4
- MkDocs Customizations
- Static Site Generators
- Writerside
- MkDocs in Vercel
- MkDocs
- Sphinx
Templates
- Concept Topics
- How-to Articles
- Task Topics
- Tutorials
- Overview Pages
- Reference Articles
- Release Notes
Tools & Scripts
- AI Tools for Docs-as-Code
- Fork (Git Client)
- API Keys for Google Apps
- Linkchecker
- NotebookLM
- Obsidian
- Terminology Check in Notepad++
- Vale
- Create VS Code Extensions