code-documentation

O que a skill ensina

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.

O que faz

Detalhes