code-documentation
A documentation skill from ByteDance's DeerFlow project that the agent loads when asked to document code, an API, a library or a repository.
What the skill teaches
A documentation skill from ByteDance's DeerFlow project that the agent loads when asked to document code, an API, a library or a repository. It starts by studying the codebase: project basics, directory structure, key files and public API surfaces, then decides what documentation is needed. It then writes what was asked for, such as a README with installation, usage and API sections, API reference pages built from the source, architecture docs with diagrams, onboarding and contribution guides, changelogs from commit history, and inline comments in each language's own format, such as JSDoc, docstrings, GoDoc, Javadoc or Rustdoc.
Capabilities
- Generate a README from codebase analysis
- Write API reference documentation from source
- Produce architecture docs with diagrams
- Generate changelogs from commit history
- Add inline doc comments in language-specific formats
About
- Publisher
- ByteDance
- Tool
- Documentation
Install
The project doesn't document install steps that we could confirm. See the project's own instructions
MCP servers and skills can run code on your computer and act on your data. Review the source before installing.
Details
| Fact | Value | Source |
|---|---|---|
| Type | Skill | |
| Tool | Documentation | |
| Publisher | ByteDance | source |
| Official status | Not stated in its documentation | |
| Needs an API key or sign-in | Not stated in its documentation | |
| Includes scripts | No | source |
| Platforms | Not stated in its documentation | |
| AI clients | Not stated in its documentation | |
| Licence | MIT | source |
| Pricing | Not stated in its documentation | |
| Activity | Last commit Nov 11, 202685,246 GitHub starsDownload data not available (not on npm or PyPI) | source |
| Links | Repository Website |
Copies of this skill in other repositories (1)
These differ from this skill's text. They may be adapted copies or older versions.
- code-documentationljxpython/ai-agent-platform
More from ByteDance
7 skills
- github-deep-research (Skill)
- data-analysis (Skill)
- deep-research (Skill)
- image-generation (Skill)
- newsletter-generation (Skill)
- video-generation (Skill)
Also listed under: Documentation
Sources
- Skill file (SKILL.md)github.com/bytedance/deer-flowNov 10, 2026
- Licence file (LICENSE)github.com/bytedance/deer-flow · Backs: LicenceNov 12, 2026
- GitHub repositorygithub.com/bytedance/deer-flow · Backs: Publisher, Activity, LicenceNov 11, 2026
- Folder in the repository (code-documentation)github.com/bytedance/deer-flow · Backs: Includes scriptsNov 10, 2026