Guide · Agent skill
How to use the Code Documentation Writer agent skill
Updated · written with AI from the project's own documentation and checked against our catalogue data
The Code Documentation Writer is an agent skill: a SKILL.md file of instructions and templates that an AI agent loads when you ask it to document code. This guide explains what the skill makes the agent do, how to install it, how to trigger it with plain requests and what to check before you publish the output. By the end you will be able to draft a README, an API reference or inline comments for a project you already have.
Code Documentation Writerbytedance/deer-flow · MIT Download the skill Quick start
- 1Download the ZIP. Download the code-documentation ZIP from this page. It contains SKILL.md.
- 2Unzip the skill. Unzip the package so the skill folder is ready to copy into a skills directory.
- 3Choose a location. Place the folder in ~/.claude/skills/ for personal use, or in a project's .claude/skills/ folder for one repository.
- 4Or upload it in the Claude apps. In the Claude apps, go to Settings → Capabilities → Skills and upload the ZIP.
- 5Open the project. Make the project you want documented available to the agent.
- 6Ask for documentation. Request what you need in plain words, such as create a README or generate API docs for the public functions.
- 7Review the output. Check every example, default and error type against the source before you publish.
What the skill makes the agent do
Once installed, the agent follows a structured process for documenting software. It first inspects the project's languages, dependencies, folder layout and entry points, such as package.json, pyproject.toml, go.mod or Cargo.toml, and checks for existing docs. It then sizes the output to the project: a single usage header for a single script, a README with API reference for a small library, and a fuller set with architecture, API, contributing and changelog docs for a large project.
- Generate README.md files with installation, usage and API reference sections
- Create API reference documentation from source code analysis
- Produce architecture documentation, including Mermaid diagrams
- Write developer onboarding and contribution guides
- Generate changelogs from commit history or release notes
- Add inline documentation in JSDoc, docstrings, GoDoc, Javadoc or Rustdoc format
Install the code-documentation skill
Download the ZIP for this skill from this page and unzip it. The package contains one file, SKILL.md. Put the unzipped folder in one of these locations:
- Personal skills: ~/.claude/skills/ so it is available across your projects
- Project skills: a .claude/skills/ folder inside the repository you want to document
- Claude apps: upload the ZIP under Settings → Capabilities → Skills
Trigger the skill with natural requests
You do not need a special command. The skill's description tells the agent when to load it, so ask for documentation the way you would ask a colleague. The source lists these example requests: "document this code", "create a README", "generate API docs", "write developer guide". Mention the project or folder so the agent knows what to read.
- Create a README for the project in this folder
- Generate API reference docs for the public functions in src/
- Add JSDoc comments to the exported functions in utils.js
- Write a developer guide for new contributors to this repository
- Document the architecture of this codebase, including a diagram
Example workflow on a small library
For a small library, ask for a README with an API reference. The agent will read the manifest and entry points, list the public functions and then fill in its README template: badges, features, prerequisites, installation, basic usage, configuration, examples, development, contributing and license. Each function entry includes a parameter table, return value, errors thrown and an example call.
Review each claim against the code before you publish. The skill writes from reading source, so it can describe a feature or default inaccurately.
What you need before you start
The source lists no required software, scripts or network access for this skill. It runs no scripts and uses no network. You need an agent environment that can load skills and read the files of the project you point it at. The skill itself only provides instructions and templates.
Safety notes
The skill does not run scripts and does not use the network, so installing it does not execute code on your machine. The agent does read your source files, so only point it at repositories you are comfortable sharing with the agent environment. Generated documentation is text based on reading code; it is not verified by running or testing the project.
- Review generated examples by running them yourself before publishing
- Check parameter defaults and error types against the source
- Do not rely on the output as proof of behaviour
Tips for better documentation
Name the scope you want. A single file, a whole package, or a set of public functions gives the agent a clear target and avoids an oversized result. If the project already has docs, ask the agent to improve them rather than replace them, since the skill checks for existing README, docs/ and inline documentation first.
- State the audience: end users, contributors or maintainers
- Ask for one document at a time for large projects
- Ask for a changelog from commit history or release notes when you need one
What people use it for
- Drafting a README for an existing repository that has none
- Producing an API reference table for a small library's exported functions
- Adding JSDoc or Google-style docstrings across a codebase
- Writing a contributor or onboarding guide for a growing project
- Creating architecture notes with a Mermaid diagram for a larger system
Frequently asked questions
How do I install the code-documentation skill?
Download the ZIP from this page and unzip it to get SKILL.md. Copy the folder into ~/.claude/skills/ for personal use or into a project's .claude/skills/ folder, or upload the ZIP in the Claude apps under Settings → Capabilities → Skills.
Does the code documentation skill require anything else to run?
The source lists no requirements. It runs no scripts and uses no network, and the package contains only SKILL.md with instructions and templates. You still need an agent environment that can load skills and read your project files.
Is the code-documentation skill free to use?
The skill is listed under the MIT licence. The source does not state pricing for any agent environment you use with it, so check the terms of that environment.
What is the difference between this skill and asking an AI to write docs directly?
The skill gives the agent a defined process: it inspects the project's structure and entry points first, sizes the documentation to the project and applies language conventions such as JSDoc, docstrings and Rustdoc. It also supplies README and reference templates to follow.
Will the generated documentation be accurate?
Not guaranteed. The skill writes from reading source code and may describe features inaccurately, so you should verify examples and claims by running and testing the project before publishing.
Why does the agent not trigger the skill for my request?
Use wording close to the skill's description, such as document this code, create a README or generate API docs, and name the project or folder. If it still does not load, confirm the folder sits directly in a skills directory it can read.
New agent skills, repos and AI tools — every week
The best new skills and open-source projects, the fastest-growing repos, and one free prompt. Five minutes to read. Unsubscribe anytime.
Our verdict
Use this skill if you want a README, API reference, inline comments or contributor guide drafted for a repository you already have, and you will review the result. Pick something else if you need documentation verified against real behaviour without review, or if you expect the skill to run or test your code, since it only contains instructions and templates.
Download the skill