İçeriğe geç
TakoAPI
Becerilere dön

technical-doc-generator

seanwyngaard tarafından

Coding Agents & IDEs
717İndirme sayıları clawskills.sh tarafından bildirilir
0Görüntülenmeler
0 beğeniBu beceriyi beğenmek için giriş yapın
—Henüz değerlendirilmedi
Puanınız

Özet

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

Açıklama

Bu Beceri Ne Yapar

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.

Ne Zaman Kullanılır

  • 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

Örnek İş Akışı

GİRİŞ

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

AJAN
  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

ÇIKIŞ

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

Kurulum

clawhub install seanwyngaard/technical-doc-generator

CLI komutunu çalıştırın ya da istemi Claude Code, Cursor, Codex veya kullandığınız kodlama ajanına yapıştırın.

Bağlantılar