outfitter-documentation

name	outfitter-documentation
description	Documentation structure and templates for READMEs, API docs, guides, and CLI references. Use when creating docs, writing READMEs, or structuring a docs/ directory.
metadata	{"version":"2.0.1","author":"outfitter","category":"documentation"}

Documentation Standards

Structure and templates for project documentation — the human-facing docs that help developers understand and use your project.

This skill covers what to include and where it goes. For how to write it:

• Load the outfitter-styleguide skill for sentence rhythm, metaphors, structural moves
• Load the outfitter-voice skill for philosophical foundation (apply as review pass)

For agent-specific documentation (CLAUDE.md, AGENTS.md), load the outfitter-agents-setup skill.

Documentation Hierarchy

Documentation is prioritized in this order:

1. Types — Self-documenting code through TypeScript types
2. Inline comments — TSDoc/JSDoc for non-obvious decisions
3. docs/ — Broader architectural and reference material

All three levels matter. Types express intent through code, comments explain why, and docs provide context.

Project Directory Structure

Standardized directory layout for documentation across repositories.

Root-Level Files

File	Purpose