📚 Skill: docs-pro (v1.1.0)
Executive Summary
docs-pro is a comprehensive skill for managing the lifecycle of technical documentation. It bridges the gap between raw implementation and user-facing clarity. In 2026, we treat Documentation as Code (DaC), using AI to ensure that every new feature, configuration, and API change is accurately reflected in our docs within minutes of a commit.
📋 Table of Contents
- Core Capabilities
- The "Do Not" List (Anti-Patterns)
- Quick Start: The Sync Audit
- Standard Production Patterns
- Documentation Quality Standards
- AI-Driven Documentation Workflow
- Reference Library
🚀 Core Capabilities
- Automated Sync Audit: Scanning codebases for undocumented exports, settings, and flags.
- Style Enforcement: Ensuring all documentation follows the 2026 Squaads AI Style Guide.
- Modular Content Architecture: Managing reusable snippets and modular pages for scalability.
- Multimodal Documentation: Integrating diagrams (Mermaid), code examples, and interactive elements.
🚫 The "Do Not" List (Anti-Patterns)
| Anti-Pattern | Why it fails in 2026 | Modern Alternative |
|---|---|---|
| "Click Here" Links | Bad for accessibility and AI context. | Use Descriptive Anchor Text. |
| Outdated Defaults | Leads to user frustration and support tickets. | Use Docs Sync Audit to verify defaults. |
| Manual Reference Docs | Impossible to maintain at scale. | Generate API refs from Code Docstrings. |
| Wall of Text | Low information retention. | Use Bullet Points, Tables, and Diagrams. |
| Mixing Languages | Makes maintenance and translation hard. | Keep English as the Source of Truth in docs/. |
⚡ Quick Start: The Sync Audit
Perform a basic check to see what's missing in your documentation:
# 1. Analyze changes in current branch vs main
git diff main...HEAD -- src/
# 2. Search for common undocumented patterns
rg "export (const|function|class)" src/ --type ts
# 3. Compare findings with docs/ structure
ls -R docs/🛠 Standard Production Patterns
Pattern A: The Feature Release Doc
When implementing a new feature, follow this checklist:
- Overview: What does it do?
- Configuration: List all environment variables and settings.
- Examples: Provide "Quick Start" and "Advanced" code blocks.
- Troubleshooting: Common errors and their fixes.
Pattern B: The API Reference Update
Instead of editing docs/ref/*.md directly:
- Update the JSDoc/TSDoc comments in the source code.
- Run the doc generator (e.g.,
make build-docs). - Verify the output matches the Markdown Standard.
📏 Documentation Quality Standards
We adhere to strict standards to ensure high utility for both humans and AI agents.
- Clarity: Active voice, present tense, and direct address.
- Accuracy: Code examples must be tested and valid.
- Discoverability: Every page must be listed in
mkdocs.ymlwith a descriptive title.
*See References: Style Guide for more.*
🤖 AI-Driven Documentation Workflow
- Inventory: AI scans the codebase to build a feature list.
- Gap Analysis: AI compares the inventory to existing
.mdfiles. - Drafting: AI proposes new content based on implementation logic.
- Review: Human-in-the-loop verification of tone and accuracy.
*See References: AI Collaboration for more.*
📖 Reference Library
Detailed deep-dives into documentation excellence:
- 2026 Style Guide: Voice, tone, and structural rules.
- Markdown Standards: Frontmatter, code blocks, and AI-friendly syntax.
- AI Collaboration Guide: How agents and humans work together on docs.
- Coverage Checklist: The master list for doc audits.
*Updated: January 22, 2026 - 17:05*