Documentation Standards & Patterns

About

This skill provides a comprehensive framework for creating and maintaining documentation in modern software projects, specifically tailored for AI-integrated workflows. It establishes clear boundaries between user-facing READMEs and developer-focused AGENTS.md files, promoting a 'thin' documentation strategy that reduces maintenance overhead by referencing universal skills. Whether you are structuring a monorepo root, a specific package, or a multi-platform plugin, this skill ensures your documentation remains accessible to humans and highly actionable for AI coding agents.

Key Features

• Multi-platform installation guide structures for Claude Code, Cursor, and other agents
• Tone guidelines that differentiate between end-user and technical contributor audiences
• Implementation of 'Thin AGENTS.md' architecture to minimize content duplication
• AI-optimized skill referencing patterns to prevent knowledge fragmentation
• 7 GitHub stars
• Standardized templates for Monorepo, Package, and Plugin-level documentation

Use Cases

• Optimizing internal developer guides for better performance with AI coding assistants
• Standardizing documentation across a complex monorepo with multiple NPM packages
• Creating clear, accessible installation instructions for multi-platform developer tools