Skip to content
Get packs

Code Documentation Writer

Lets the agent write READMEs, API references, code comments, changelogs and developer guides from your codebase.

Source Download skill
Repository
bytedance/deer-flow
Stars
84,876
Licence
MIT
Files
1 file

What it does

When installed, the agent follows a structured process for documenting software: it first inspects the project's languages, dependencies, folder layout and entry points, then produces documentation sized to the project, such as a single README for a small library or a fuller set with architecture, API and contributing docs for a large one. It also applies language conventions like JSDoc, docstrings, GoDoc, Javadoc and Rustdoc, and provides templates for README sections and function/class reference tables.

Great for

  • Developers who want a README or API reference drafted for an existing repository
  • Maintainers writing contributor or onboarding guides for a growing project
  • Teams adding inline docstrings or JSDoc comments across a codebase

Skip it if

  • Projects where the documentation must be verified against real behaviour without review: the skill generates text from reading source code and may describe features inaccurately
  • Users expecting it to run or test the code: the file only provides instructions and templates, with no scripts included

Try asking

  • “Document this code: create a README for my Python library in this folder”
  • “Generate API reference docs for the functions in src/ with parameter tables and examples”
  • “Write a developer guide and contribution guide for this repository”
  • “Add JSDoc comments to the exported functions in my TypeScript project”
Step-by-step guide: how to use Code Documentation WriterInstall, first run, examples, tips and FAQs

Install in 3 steps

  1. 1

    Download the skill

    The ZIP contains the 1 original files, the MIT licence and an attribution note.

    code-documentation.zip
  2. 2

    Add it to your agent

    Claude Code (all projects)

    mkdir -p ~/.claude/skills && unzip code-documentation.zip -d ~/.claude/skills/

    Claude Code / Agent SDK (this project only)

    mkdir -p .claude/skills && unzip code-documentation.zip -d .claude/skills/

    Claude apps (web/desktop): Settings → Capabilities → Skills → Upload skill, and choose the ZIP.

  3. 3

    Ask for the task

    No special command needed — the agent reads the skill's description and loads it when your request matches. Try one of the prompts above.

Get better results

  • Point the agent at the project folder and say which audience the docs are for (new contributors, API users, or both)
  • Review generated API examples and version numbers against the real code before publishing
  • Ask for one document type at a time (for example, README first) to keep results focused

What's inside

  • SKILL.md

Redistributed unmodified from bytedance/deer-flow under the MIT licence. The assessment was drafted with AI from the skill's files on 2026-10-29. Skills can instruct your agent to run code — read SKILL.md and any scripts before installing.