document

Write accurate, minimal documentation for code, features, and systems.

Updated Apr 13, 2026
One-click install
npx skills add https://github.com/tsmes/conaro --skill document-tsmes
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document
Source: https://github.com/tsmes/conaro/tree/main/.claude/skills/document
Command: npx skills add https://github.com/tsmes/conaro --skill document-tsmes

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Codebases accumulate undocumented features, stale READMEs, and docs that restate what the code already says. This Skill produces documentation that explains the why, the connections, and the non-obvious decisions, while validating every claim against the actual implementation. ## Core Features & Use Cases - Context-Gathered Drafting: Reads project conventions (CLAUDE.md, CONTRIBUTING.md, README.md, ADRs) and investigates code with parallel sub-agents before writing, so docs match existing tone and structure. - Multiple Documentation Types: Supports feature docs, API references, architecture overviews, how-to guides, code tours, and README/CONTRIBUTING files, with placement conventions for each. - Validation Pass: Verifies drafted documentation against the actual code — checking behaviors, code examples, and file paths — before presenting it. - Use Case: After shipping a new application-review feature, ask for a code tour; the Skill investigates the execution path, drafts a walkthrough following project conventions, and validates every claim against the source. ## Quick Start Document the artist application flow as a code tour for developers who need to modify it.

Frequently Asked Questions about document

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I document a feature in an existing codebase?▼

Start by reading project docs like README and CONTRIBUTING to learn conventions, then investigate the feature's code to understand what it does and why. Draft documentation that explains intent and connections rather than restating what the code already shows.

What types of technical documentation can this generate?▼

It supports feature documentation, API references, architecture overviews, how-to guides, code tours, and README or CONTRIBUTING files. The type is determined from your request and existing project conventions rather than rigid templates.

How is generated documentation validated against the code?▼

A validation step checks the draft against the actual implementation: whether described behaviors match the code, code examples are correct and runnable, and file paths and references are accurate. Discrepancies are fixed before the documentation is presented.

Where should new documentation files be placed in a repository?▼

Follow existing project conventions first. If none exist, defaults are docs/[feature-name].md for features, docs/api/ for API references, docs/architecture/ for architecture, docs/how-to/ for guides, and docs/tours/ for code tours.

When should I not write documentation for code?▼

Skip documentation that restates what the code already communicates, such as describing that getUserById gets a user by ID. Also avoid documenting internal implementation details that change frequently, since those docs rot quickly.