Code Documentation

This does the heavy lifting when you need to turn code into actual documentation. It analyzes your codebase first (checking package files, directory structure, entry points) before generating anything, which means you get READMEs that match your project's actual setup rather than generic templates. It covers the full range: inline comments following language conventions, API references with proper parameter tables, architecture docs with Mermaid diagrams, and contribution guides. The workflow is thorough, maybe even a bit formal, but that's the point. If you've ever stared at an undocumented repo wondering where to start, or needed to generate API docs that don't look like an afterthought, this handles it systematically.

skills.sh installs: 1.9K
GitHub stars: 85.2K
last updated: Aug 21, 2026

View on GitHub

Install

$ npx -y skills add bytedance/deer-flow --skill code-documentation --agent claude-code

Installs into .claude/skills of the current project.

Files

Code Documentation Skill

Overview

This skill generates professional, comprehensive documentation for software projects, codebases, libraries, and APIs. It follows industry best practices from projects like React, Django, Stripe, and Kubernetes to produce documentation that is accurate, well-structured, and useful for both new contributors and experienced developers.

The output ranges from single-file READMEs to multi-document developer guides, always matched to the project's complexity and the user's needs.

Core Capabilities

Generate comprehensive README.md files with badges, installation, usage, and API reference
Create API reference documentation from source code analysis
Produce architecture and design documentation with diagrams
Write developer onboarding and contribution guides
Generate changelogs from commit history or release notes
Create inline code documentation following language-specific conventions
Support JSDoc, docstrings, GoDoc, Javadoc, and Rustdoc formats
Adapt documentation style to the project's language and ecosystem