code-documentation SKILL.md skillA
code-documentation from bytedance/deer-flow is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add bytedance/deer-flow/code-documentation@git:20260405.8bb14faPins git:20260405.8bb14fa in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- bytedance/deer-flow
- Path
skills/public/code-documentation/SKILL.md- Versions recorded
- 1
- Latest version
- git:20260405.8bb14fa, committed Apr 5, 2026
- Size
- 13,877 bytes
- Repository stars
- 85,141
- License
- MIT
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.
Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file the same grade.
What the file says
# 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:** …
Read the whole file at its exact version.
How to install
mdr add bytedance/deer-flow/code-documentation@sha256:75721d7bc1b29459The line at the top of this page pins the label git:20260405.8bb14fa, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.
[](https://markdownregistry.com/a/art_5bziwdxz2ohzecc2)
4 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 1 version of this file, committed on Apr 5, 2026.
Audit of the latest version
- pass: Frontmatter block present
- pass: Frontmatter declares a name
- pass: Frontmatter declares a description
- pass: Size between 200 bytes and 200 KB (13877 bytes)
- pass: No zero-width or bidi control characters
- pass: No instruction hidden inside an HTML comment
- pass: No link to an exfiltration or paste host
- pass: No credential-shaped string
- pass: No instruction to send local credentials anywhere
- pass: No text hidden with inline styles
- pass: No prompt-injection phrasing
- pass: No curl or wget piped into a shell
- pass: No recursive delete of root, home or parent
- pass: No instruction to read or print local credentials
- pass: No base64 blob over 200 characters
- pass: No link to a raw IP address
- pass: No script tag
Source
bytedance/deer-flow · 85,141 stars · license MIT · pushed 2026-11-08 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_5bziwdxz2ohzecc2 GET https://markdownregistry.com/api/v1/resolve?ref=bytedance/deer-flow/code-documentation GET https://markdownregistry.com/api/v1/blob/75721d7bc1b294592dc31a1e1d92ff9c390115af4b08ed42e7e0a2b094060676
Your AI assistant does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.
Guides: the SKILL.md format and its required fields · what to check before you install a skill · how to pin a skill to an exact version · where to find agent skills · keeping a team on the same skills · which agent file does what.