How does it handle code examples?

It enforces strict requirements for runnable examples, ensuring they include all necessary imports, demonstrate both success/failure states, and use domain-relevant context.

Can I use this for CLI tools?

Yes, it includes specialized templates for CLI command references that cover arguments, options, usage examples, and exit codes for a professional developer experience.

What is the recommended documentation hierarchy?

The skill prioritizes self-documenting TypeScript types first, followed by JSDoc/TSDoc inline comments for logic, and finally broader architectural docs in a dedicated docs/ directory.

How does this skill help with README creation?

It provides a proven template focusing on value propositions, copy-pasteable quick starts, and clear links to deeper documentation to improve user onboarding.

Documentation & README Architect

Name: Documentation & README Architect
Author: outfitter-dev

byoutfitter-dev

0•

Learning & Documentation

Standardizes project documentation using structured templates for READMEs, API references, CLI guides, and directory layouts.

The docs-write skill provides a comprehensive framework for creating professional, human-centric project documentation within the Claude Code environment. It establishes a clear hierarchy between self-documenting code, inline comments, and external documentation while providing standardized templates for root-level files like READMEs and specialized directories for architecture, APIs, and CLI references. By implementing these patterns, developers ensure their projects are discoverable, scannable, and maintainable, with a specific focus on copy-pasteable quick starts and consistent stability labeling.

Key Features

01High-conversion README templates with quick start and stability labels

02Best practices for runnable code examples and configuration tables

03Standardized project directory layouts for architecture, APIs, and guides

04Detailed CLI command reference templates including synopsis and exit codes

05Integrated documentation hierarchy prioritizing self-documenting code

060 GitHub stars

Use Cases

01Generating comprehensive CLI references and API guides for developer tools

02Standardizing documentation across multiple repositories in a corporate environment

03Bootstrapping a new open-source project with a professional README and docs structure

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add outfitter-dev/agents-internal docs-write

For use in Claude.ai and ChatGPT

Download Skill