Skip to content
Kitbay
Submit
Skill

code-documentation

MITUpdated on Nov 11, 202685,246GitHub stars

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