Agent skill · writing content · bytedance
code-documentation
Use this skill when the user requests to generate, create, or improve documentation for code, APIs, libraries, repositories, or software projects. Supports README generation, API reference documentation, inline code comments, architecture documentation, changelog generation, and developer guides. Trigger on requests like "document this code", "create a README", "generate API docs", "write developer guide", or when analyzing codebases for documentation purposes.
Why this skill is useful
Generates comprehensive documentation templates and workflows that the AI wouldn't reliably create on its own.
What it needs
About 8k tokens when loaded. Last updated 2026-08-07. 79,444 stars on the source repository.
What this skill does
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 When to Use This Skill Always load this skill when: User asks to "document", "create docs", or "write documentation" for any code User requests a README, API reference, or developer guide User shares a codebase or repository and wants documentation generated User asks to improve or update existing documentation User needs architecture documentation, including diagrams User requests a changelog or migration guide Documentation Workflow Phase 1: Codebase Analysis Before writing any documentation, thoroughly understand the codebase. Step 1.1: Project Discovery Identify the project fundamentals: Field How to Determine ------- ----------------- Language(s) Check file extensions, package.json, pyproject.toml, go.mod, Cargo.toml, etc. Framework Look at dependencies for known frameworks (React, Django, Express, Spring, etc.) Build System Check for Makefile, CMakeLists.txt, webpack.config.js, build.gradle, etc. …
How to use it
Reference it in AdaL, Claude Code, Cursor or any coding agent — nothing to install:
@skills bytedance/code-documentation