本文へスキップ
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などお使いのコーディングエージェントにプロンプトを貼り付けてください。

リンク