How does it handle different project maturity levels?

It utilizes literal Stability Tier Labels—Stable, Active, and Early—to clearly communicate to users whether APIs are locked or expected to change.

What is the documentation hierarchy used by this skill?

It prioritizes information in three levels: first, self-documenting TypeScript types; second, inline TSDoc/JSDoc comments for decisions; and third, the docs/ directory for broad architectural context.

How long should a project README be according to these standards?

The target length is 150-250 lines. While it can go up to 400 lines, anything longer should be extracted into the docs/ directory to maintain scannability.

Does this skill provide templates for CLI tools?

Yes, it includes specific standards and templates for CLI command references, including flags, usage examples, and exit codes.

Outfitter Documentation Standards

Name: Outfitter Documentation Standards
Author: outfitter-dev

byoutfitter-dev

•

Learning & Documentation

Standardizes project documentation through structured templates for READMEs, API references, and architectural guides.

This skill provides a comprehensive framework for creating human-centric documentation in software projects. It establishes a clear hierarchy starting from self-documenting code to high-level architectural records, offering standardized directory structures and templates for root-level files like READMEs and CONTRIBUTING guides. By defining specific standards for code examples, API documentation, and CLI references, it ensures that project documentation remains consistent, scannable, and maintainable across the entire development lifecycle.

Key Features

01Standardized project directory layouts for architecture, API, and CLI docs

022 GitHub stars

03Stability tier labels to clearly communicate maturity levels of components

04Best practices for copy-paste runnable code examples and error demonstrations

05Formalized API and function documentation standards using TSDoc/JSDoc patterns

06Template-driven README creation with specific length and content guidelines

Use Cases

01Writing comprehensive API and CLI references that follow consistent formatting

02Structuring a new repository with standardized documentation folders and root files

03Auditing existing project documentation using a built-in review checklist

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add outfitter-dev/outfitter outfitter-documentation

For use in Claude.ai and ChatGPT

Download Skill