technical-docs

Installation
SKILL.md

Documentation

Technical writing, diagram-as-code, and documentation lifecycle management. Treats docs as code: version-controlled, linted, and CI-verified.

When to use: Creating or updating technical documentation, generating Mermaid diagrams (flowcharts, ERDs, sequence diagrams), auditing documentation coverage against code, or establishing style guides.

When NOT to use: Writing marketing copy, blog posts, or content that does not live alongside code.

Quick Reference

Task Approach Key Point
Doc sync audit git diff main...HEAD + export scan Compare symbols against doc coverage
Sequence diagram Mermaid sequenceDiagram + autonumber Map messages to function calls
ERD Mermaid erDiagram + Crow's Foot Derive from Drizzle/Prisma schemas
Gitgraph Mermaid gitGraph Standardize on main/develop/feature branches
Feature release doc Overview + Config + Examples + Troubleshooting Checklist for every new feature
API reference Generate from JSDoc/TSDoc annotations Never write API refs manually
Style guide Active voice + present tense + direct address Conversational but precise
Related skills
Installs
62
GitHub Stars
11
First Seen
Feb 22, 2026