跳到正文
TakoAPI
返回技能列表

technical-doc-generator

由 seanwyngaard 提供

Coding Agents & IDEs
717下载量由 clawskills.sh 提供
0浏览量
0 个赞登录后即可为这个技能点赞
—暂无评分
你的评分

简介

Generate professional technical documentation from codebases — API docs, READMEs, architecture diagrams.

描述

该技能的功能

Scans a local codebase and generates technical documentation across five formats: API docs, READMEs, architecture overviews, changelogs, and developer onboarding guides. Run it with a path and a doc type argument, or use 'full' to produce the complete set in a docs/ directory.

Covers all common documentation types in a single command rather than requiring separate tools or manual effort for each format.

何时使用

  • Documenting a REST API before client handoff
  • Writing a README for a new open source repo
  • Building an onboarding guide for an incoming developer
  • Generating a structured changelog from git commit history
  • Producing an architecture overview for a codebase audit

示例工作流

输入

User asks: /technical-doc-generator ./src api-docs

智能体
  1. 1

    Scans package files and config to identify the project stack

  2. 2

    Detects the API framework (Express, FastAPI, Django, etc.)

  3. 3

    Extracts routes, methods, parameters, and request/response bodies

  4. 4

    Generates an OpenAPI YAML spec and a human-readable Markdown file

  5. 5

    Saves output to output/docs/ and presents a summary

输出

API.md with endpoint documentation and openapi.yaml saved to output/docs/

安装

clawhub install seanwyngaard/technical-doc-generator

运行 CLI 命令,或把这段提示词粘贴到 Claude Code、Cursor、Codex 或你在用的任意编程智能体里。

链接