LogoClawIndex
CasesSkillsAbout
LogoClawIndex

documentation - Generate technical documentation from codebases

Comprehensive workflow for generating API docs, architecture docs, README files, code comments, and technical content

Tags

Updated: 2026-03-19
documentationworkflowtechnical writingAPI documentationarchitecturecode documentationwikichangelog

Capabilities

identify documentation needschoose documentation toolsplan documentation structuredefine style guidelines

Typical Inputs

codebaseAPI endpointssource code files

Typical Outputs

API documentationarchitecture diagramsREADME files

What this skill does

  • identify documentation needs
  • choose documentation tools
  • plan documentation structure
  • define style guidelines
  • set up documentation site
  • extract API endpoints
  • generate OpenAPI specs
  • create API reference
  • add usage examples
  • set up auto-generation
  • create C4 diagrams
  • document architecture
  • generate sequence diagrams
  • document data flows
  • create deployment docs
  • extract code comments
  • generate JSDoc/TSDoc
  • create type documentation
  • document functions
  • create README

Inputs

  • codebase
  • API endpoints
  • source code files
  • code comments
  • commit history
  • OpenAPI specs
  • technical content

Outputs

  • API documentation
  • architecture diagrams
  • README files
  • code documentation
  • user guides
  • wiki pages
  • tutorials
  • changelogs
  • release notes

Requirements

  • documentation generation support

Source

  • Spec: SKILL.md

ClawIndex

OpenClaw Skills & Use Case Index

ClawIndex is an ecosystem-driven index of OpenClaw skills and real-world use cases.

Index

Skills·
Cases

Meta

About·
Disclaimer·
Email·
GitHub
© 2026 ClawIndex All Rights Reserved.