Bỏ qua tới nội dung
TakoAPI
Quay lại kỹ năng

technical-doc-generator

bởi seanwyngaard

Coding Agents & IDEs
717Lượt tải do clawskills.sh công bố
0Lượt xem
0 lượt thíchĐăng nhập để thích kỹ năng này
—Chưa có đánh giá
Đánh giá của bạn

Tóm tắt

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

Mô tả

Kỹ năng này làm gì

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.

Khi nào nên dùng

  • 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

Quy trình ví dụ

ĐẦU VÀO

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

AGENT
  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

ĐẦU RA

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

Cài đặt

clawhub install seanwyngaard/technical-doc-generator

Chạy lệnh CLI, hoặc dán prompt vào Claude Code, Cursor, Codex hay coding agent bạn đang dùng.

Liên kết