본문으로 건너뛰기
TakoAPI
스킬로 돌아가기

technical-doc-generator

seanwyngaard 제작

Coding Agents & IDEs
717clawskills.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 등 사용하는 코딩 에이전트에 붙여넣으세요.

링크