Skills

Document

Write or update repository/product documentation: README, user guides, API docs...

Install

npx skills add codewhale-hq/Codewhale --skill document -g -a claude-code -y
Repository
codewhale-hq/Codewhale41.2k
Category
Git and review
Updated
3d ago
License
MIT
Context cost
Lightabout 109 tokens
Runs scripts
No, instructions only

What it does

Write or update repository/product documentation: README, user guides, API docs, architecture, migration notes, and changelog material. This is not the Word-document artifact skill.

Document

When to use

Use for repo/product docs: README, guides, API docs, architecture, migrations, changelog notes.

Non-goals

  • Not Word/DOCX authoring (use docx).
  • Not release publication (use release only when explicit).

Workflow

  1. Identify the doc audience and location.
  2. Prefer updating existing docs over creating duplicates.
  3. Keep commands and paths verified.
  4. Call out unknowns instead of inventing them.

More in Git and review