New: 97,000+ skills indexed from GitHub repos with 100+ stars · every skill safety-checkedBrowse top skillsTop skills
Esc to closeBrowse all skills
Submit a skillBrowse skills
Submit a skillBrowse skills

Agent skill

Document

by codewhale-hq in codewhale-hq/Codewhale

Write or update repository/product documentation: README, user guides, API docs, architecture, migration notes, and changelog material.

MITAuto-check passedDevelopment

Install Document

skills CLI
$ npx skills add codewhale-hq/Codewhale --skill document -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install codewhale-hq/Codewhale document --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/codewhale-hq/Codewhale.git skills-src && mkdir -p .claude/skills && cp -r skills-src/crates/tui/assets/skills/document .claude/skills/document && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
document
GitHub stars
41k
Token cost
~170 tokens
SKILL.md length
60 words
Files
1
Skills in repo
63
Repo updated
First seen
Licence
MIT

At a glance

Write or update repository/product documentation: README, user guides, API docs, architecture, migration notes, and changelog material.

  • Works in 4 steps: Identify the doc audience and location. → Prefer updating existing docs over… → Keep commands and paths verified. → …
  • Tasks that involve Technical writing
  • SKILL.md covers When to use, Non-goals and Workflow
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md

What it does

Document is an agent skill from codewhale-hq/Codewhale. 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.

Its SKILL.md is about 170 tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.

It sits in Development, covering Technical writing, Technical documentation and Word documents. It works with Microsoft Word. The repository describes itself as: Open-source coding agent for your terminal, built in Rust and on a journey of continuous community improvement. Issues and PRs welcome. The licence is MIT.

When your agent uses it

  • Tasks that involve Technical writing
  • Tasks that involve Technical documentation
  • Tasks that involve Word documents

Example prompts

  • “/document”

Workflow steps

4 steps, taken from the first numbered list in SKILL.md.

  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.

What it can do on your machine

Read from SKILL.md and the folder at commit ad333fd. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    No scripts in the folder and no shell commands in SKILL.md.

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Document loads about 170 tokens when it runs. Until then it costs about 48 tokens; SKILL.md has 60 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~48
When it runs · the whole SKILL.md, loaded when a task matches
~170

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from codewhale-hq/Codewhale at commit ad333fd, republished under its MIT licence (© codewhale-hq). 60 words, ~170 tokens.

Download SKILL.mdSave it as .claude/skills/document/SKILL.md (or your agent's skills folder).
name
document
description
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.
invocation
model+user

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.

© codewhale-hq, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

Just SKILL.md in crates/tui/assets/skills/document of codewhale-hq/Codewhale.

Open the folder on GitHubat commit ad333fd

Compare with similar skills

Document next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Document compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Document this skillcodewhale-hq/Codewhale41k—~170Automated safety check: PassMIT
Updating Docs For Releasestreamlit/docs178—~4kAutomated safety check: PassApache-2.0
Technical Writingfrappe/skills146—~1.1kAutomated safety check: PassNone
Documentationaiskillstore/marketplace4301 repos~2.7kAutomated safety check: PassNone
User Manual Authoringdevcodex-labs/devcodex439—~1.9kAutomated safety check: PassAGPL-3.0
Release Notes Generatoramplitude/builder-skills159—~684Automated safety check: PassNone

Similar skills

  • Updating Docs For Release

    streamlit/docs

    Update the streamlit/docs repo for a new Streamlit release. An agent skill from streamlit/docs.

    178 GitHub stars~4k tokensUpdated yesterday
    DevelopmentAuto-check passed

  • Technical Writing

    frappe/skills

    Write prose in "Simplified Technical English". An agent skill from frappe/skills.

    146 GitHub stars~1.1k tokensUpdated 7 days ago
    DevelopmentAuto-check passed

  • Documentation

    aiskillstore/marketplace

    Comprehensive documentation specialist covering API documentation, technical writing, design documentation, migration guides, and changelog generation.

    430 GitHub starsUsed in 1 repo~2.7k tokens
    DevelopmentAuto-check passed

  • User Manual Authoring

    devcodex-labs/devcodex

    开源/公开用户站点与最终用户手册写作 Owner — guide/README/reference/migration/changelog/operations；与维护者开发站不等价；经 DocsAudienceIntent 路由。

    439 GitHub stars~1.9k tokensUpdated 20 days ago
    DevelopmentAuto-check passed

  • Release Notes Generator

    amplitude/builder-skills

    Read completed tickets from Linear, Jira, or GitHub Issues, filter to user-visible changes, group by product area, and write polished user-facing release notes saved as a .docx to Google Drive.

    159 GitHub stars~684 tokensUpdated 2 mo ago
    DevelopmentAuto-check passed

  • Developer Docs Planning

    hashgraph-online/awesome-codex-plugins

    Plan developer documentation by choosing content types, defining scope, making documentation decisions, researching features, planning scenarios, and turning user needs into a practical…

    1.2k GitHub stars~913 tokensUpdated yesterday
    DevelopmentAuto-check passed

More from codewhale-hq/Codewhale

All 63 skills in this repo

  • Codewhale Dogfood Install

    codewhale-hq/Codewhale

    Proves a Codewhale change in the real product: a stamped release build, an atomic local install, fresh-shell verification and manual QA that automated gates cannot cover.

    41k GitHub stars~1.3k tokensUpdated today
    Auto-check passed

  • Codewhale Session Handoff

    codewhale-hq/Codewhale

    Writes a paste-ready handoff for the next agent session, opening with a state-check command block and separating done, suspected and blocked work.

    41k GitHub stars~1.1k tokensUpdated today
    Auto-check passed

  • Codewhale Landing Workflow

    codewhale-hq/Codewhale

    Decides how verified work should reach main, directly, in a worktree or on an integration branch, while keeping contributor credit and respecting merge gates.

    41k GitHub stars~1.6k tokensUpdated today
    Auto-check passed

  • Sub-Agent Delegation

    codewhale-hq/Codewhale

    Guides when and how to split multi-step coding, research or verification work into focused sub-agent runs while the parent keeps integration and final checks.

    41k GitHub stars~790 tokensUpdated today
    Auto-check passed

  • Codewhale Fleet Manager

    codewhale-hq/Codewhale

    Triages and manages Codewhale fleet runs and workers with typed commands, classifying failures and choosing a safe restart, resume or escalation.

    41k GitHub stars~1.2k tokensUpdated today
    Auto-check passed

  • GitHub Issue Bulk Assigner

    codewhale-hq/Codewhale

    Moves a list of GitHub issues into a milestone or assigns them to owners with the gh CLI, checking each one before and after the change.

    41k GitHub stars~953 tokensUpdated today
    Auto-check passed

Works with

Categories

Questions about Document

What does Document do?

Write or update repository/product documentation: README, user guides, API docs, architecture, migration notes, and changelog material. Document is an agent skill from codewhale-hq/Codewhale. Write or update repository/product documentation: README, user guides, API docs, architecture, migration notes, and changelog material.

When should I use Document?

Document fits situations like: tasks that involve Technical writing; tasks that involve Technical documentation; tasks that involve Word documents.

How do I install Document in Claude Code?

Run `npx skills add codewhale-hq/Codewhale --skill document -a claude-code`. Or copy the skill folder (crates/tui/assets/skills/document in codewhale-hq/Codewhale) into .claude/skills/document in your project. Claude Code loads it when a task matches its description.

How do I install Document in Codex?

Run `npx skills add codewhale-hq/Codewhale --skill document -a codex`. Or copy the skill folder (crates/tui/assets/skills/document in codewhale-hq/Codewhale) into .agents/skills/document in your project. Codex loads it when a task matches its description.

Can I use Document in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add codewhale-hq/Codewhale --skill document -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/document, .gemini/skills/document, .github/skills/document and .opencode/skills/document in your project.

What does Document need to run?

SKILL.md names no scripts, command-line tools or credentials: Document is instructions for the agent only.

Does Document access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is Document safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Document use?

Document is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Document use?

About 170 tokens (SKILL.md is roughly 680 characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Document?

Skills that share tags, products or a category with Document: Updating Docs For Release (streamlit/docs, 178 stars), Technical Writing (frappe/skills, 146 stars), Documentation (aiskillstore/marketplace, 430 stars) and User Manual Authoring (devcodex-labs/devcodex, 439 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Document?

codewhale-hq (a GitHub organization) maintains it in codewhale-hq/Codewhale, which has 41,067 GitHub stars. The repository holds 63 skills in this directory. The repository was last updated on October 7, 2026.

Source: codewhale-hq/Codewhale on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.