Documentation

Use when creating, auditing, or upgrading READMEs, API references, developer guides, docstrings, PR descriptions, or related project documentation.

9 stars 3 forksWriting & Content

Install

skills CLI (Claude Code, Cursor, Codex and more)
npx skills add sandbaseai/workbuddy-skill --skill documentation
Manual install
git clone --depth 1 https://github.com/sandbaseai/workbuddy-skill.git /tmp/workbuddy-skill
mkdir -p ~/.claude/skills
cp -r /tmp/workbuddy-skill/skills/documentation ~/.claude/skills/documentation

Personal skills live in ~/.claude/skills. Use .claude/skills in a project folder to share a skill with your team.

From the SKILL.md

# Documentation

Turn a real repository into accurate, useful, scannable documentation. Inspect the project before writing. Source code, manifests, lockfiles, tests, CI, configuration, existing docs, and license files are evidence; guesses are not.

## Determine the documentation task

Classify the work as create, upgrade, audit, rewrite, or focused section. Identify the audience: end user, contributor, developer, package consumer, reviewer, or a mix. For a multi-document change, list the surfaces first and keep their terminology and commands consistent.

## Build an evidence map

Inspect the tree, project type, manifests and lockfiles, entry points, scripts, configuration, environment examples, tests, CI/CD, containers, license and security files, and relevant source behavior. Map each factual claim to evidence and confidence. If a fact is missing or contradictory, omit it or label it as unknown and investigate rather than inventing it.

Never fabricate commands, features, supported platforms, versions, metrics, links, screenshots, badges, roadmap items, coverage, or production-readiness claims. Do not silently document behavior that conflicts with the implementation; record the discrepancy and its owner.

## Write for scanning and action

For a README, answer quickly: what is this, why use it, what can it do, can it be trusted, how is it installed, how is it used, and where is deeper documentation? Prefer this order when justified:

1. value proposition and verified proof;
Read the full skill on GitHub

Details

Skill name
documentation
Path
skills/documentation/SKILL.md
License
MIT
Repo updated
8 September 2026

FAQ

What does the Documentation skill do?

Use when creating, auditing, or upgrading READMEs, API references, developer guides, docstrings, PR descriptions, or related project documentation.

How do I install the Documentation skill?

skills CLI (Claude Code, Cursor, Codex and more): npx skills add sandbaseai/workbuddy-skill --skill documentation. Skills go in ~/.claude/skills (personal) or .claude/skills (project), and Claude loads them automatically when a task matches the description.

Is Documentation popular?

It lives in sandbaseai/workbuddy-skill, which has 9 GitHub stars and 3 forks.

Related skills

Browse the most popular Claude skills, all writing & content skills, or write your own with the skills generator.