documentation-patterns
Documentation Patterns
Use this skill when the main problem is document shape and consistency rather than writing quality alone.
Activation Conditions
- Creating a new API, feature, or config guide
- Standardizing Markdown sections across repositories
- Writing migration or runbook documents
- Picking the right template for a doc request
Pattern Selection
- API docs: endpoints, auth, request and response schema, errors
- Feature docs: purpose, UX, dependencies, rollout, support
- Config docs: env vars, defaults, examples, failure modes
- Migration docs: changed behavior, upgrade path, verification
References & Resources
Documentation
- API Documentation Templates - Endpoint, SDK, and function documentation patterns
- Feature Documentation Templates - Feature overview, rollout, and troubleshooting patterns
- Configuration Documentation Templates - Config and environment variable templates
Scripts
- Doc Template Picker - Print a starter Markdown template for
api,feature,config, ormigration
Related Skills
| Skill | Relationship |
|---|---|
| documentation-authoring | Use patterns when creating new documents |
| documentation-quality | Quality standards that patterns should follow |
| breaking-changes-management | Templates for migration guides and changelogs |
More from practicalswan/agent-skills
powerpoint-ppt
PowerPoint (.pptx) manipulation via MCP server. Use for creating slides, formatting presentations, managing placeholders, adding images, applying templates, or extracting text from .pptx files.
144word-document
Word (.docx) manipulation via MCP server. Use for reading, creating, editing, formatting Word documents including tables, footnotes, comments, images, headers, styles, and PDF conversion.
121serena-usage
Serena MCP for project memory and code navigation. Use when managing Serena memories, navigating symbols, performing intelligent refactoring, or maintaining context/continuity across AI agent sessions.
19powerbi-modeling
Power BI semantic models - DAX measures, star schemas, relationships, RLS, and performance tuning via MCP. Use when creating data models, writing DAX, or configuring table relationships in Power BI.
16stitch-design
Google Stitch design toolkit — DESIGN.md generation, screen-to-React conversion, shadcn/ui integration, prompt enhancement, and Remotion walkthroughs. Use when working with Stitch MCP design projects.
15php-development
PHP 8.0+ development — XAMPP, RESTful APIs, PDO/MySQL/MariaDB, and authentication. Use when building PHP backends, creating API endpoints, configuring XAMPP, or integrating PHP with databases.
14