code-documentation
The user requests to generate, create, or improve documentation for code, APIs
by bytedanceFree
Description
code-documentation is an agent skill from the DeerFlow project that writes documentation for software projects, libraries and APIs. It produces anything from a single README to a multi-document developer guide, and it sizes the output to the project's complexity and the reader. Its core capabilities include a README with badges, installation steps, usage and an API reference, API reference generated from source code, architecture documents with diagrams, onboarding and contribution guides, and changelogs written from commit history or release notes. For code comments it writes inline documentation in each language's own convention, including JSDoc, Python docstrings, GoDoc, Javadoc and Rustdoc. The skill says it follows the documentation practices of projects such as React, Django, Stripe and Kubernetes, and it adapts the style to the language and ecosystem of the codebase. It is useful when a project has code but little documentation, or when existing docs have fallen behind the code. Install it with npx skills add https://github.com/bytedance/deer-flow --skill code-documentation.…
Highlights
- READMEs with badges, installation, usage and API reference
- API reference built from source code analysis
- Architecture documents with diagrams and onboarding guides
- Changelogs from commit history or release notes
- Inline docs for JSDoc, docstrings, GoDoc, Javadoc and Rustdoc
Ratings & Reviews
No ratings yet
Be the first to rate code-documentation.
People also visit
understand-onboard
Generate an onboarding guide for new team members joining a project
code-documentation FAQ
What can it document?
Code, APIs, libraries, repositories and whole software projects, from a single README to multi-document developer guides.
Does it write comments inside the code?
Yes. It writes inline documentation following the convention of the language, such as JSDoc, docstrings, GoDoc, Javadoc or Rustdoc.
Can it write a changelog?
Yes. It generates changelogs from commit history or from release notes.
How do I install it?
Run npx skills add https://github.com/bytedance/deer-flow --skill code-documentation.
Which security audits does it have?
On skills.sh, Gen Agent Trust Hub, Socket and Snyk all pass.
What are the best code-documentation alternatives?
Popular alternatives to code-documentation include context7-mcp, understand-domain and understand-onboard. See all code-documentation alternatives