docs-write

This skill provides a comprehensive framework for creating, organizing, and maintaining human-facing technical documentation. It ensures that projects follow a consistent structure, making it easier for developers to navigate, contribute to, and understand complex codebases. By establishing clear standards for project directory layouts—including architecture decision records (ADRs), API specifications, CLI command references, and development workflows—the skill creates a predictable environment for both maintainers and new contributors.

• Standardizes root-level documentation files like README.md, CONTRIBUTING.md, and CHANGELOG.md to provide clear entry points.

• Implements a tiered documentation hierarchy focusing on TypeScript types, inline JSDoc/TSDoc comments, and structured /docs folders.

• Defines specific templates for READMEs, ensuring features, installation steps, and quick-start guides are scannable and actionable.

• Includes rigorous standards for CLI documentation, such as synopsis, arguments, options, and error handling demonstrations.

• Provides clear distinction between README content (quick start) and deep-dive documentation (architecture, API, tutorials).

• Leverages stable maturity labels to clarify the status of different components, packages, or systems.

• Designed for technical teams, open-source maintainers, and internal project developers who prioritize maintainability.

• Best used when bootstrapping new repositories, restructuring outdated documentation, or implementing consistent project standards across an organization.

• Pair this skill with internal:styleguide for prose and tone, and internal:voice for the philosophical alignment of the project.

• Expected inputs include project structure goals, architectural decisions, and API metadata. The output is consistently formatted, professional, and accessible documentation that acts as a single source of truth for the project.