المهارات code-documentation-doc-generate
📦

code-documentation-doc-generate

آمن

自動生成程式碼文件

運用 AI 驅動的分析技術，從原始碼建立完整的 API 文件、架構圖表、使用者指南與技術參考資料。

يدعم: Claude Codex Code(CC)
🥉 75 برونزي
1

تنزيل ZIP المهارة

2

رفع في Claude

اذهب إلى Settings → Capabilities → Skills → Upload skill

3

فعّل وابدأ الاستخدام

اختبرها

استخدام "code-documentation-doc-generate". Generate API documentation for a FastAPI user service with endpoints for create, read, update, delete users

النتيجة المتوقعة:

  • API 文件已建立，包含：
  • - OpenAPI 3.0 規格
  • - 使用者端點（/users、/users/{id}）
  • - 含驗證的請求/回應 schema
  • - 驗證與授權章節
  • - 各端點的範例 curl 指令

استخدام "code-documentation-doc-generate". Create a README for a Python CLI tool that converts images to PDF

النتيجة المتوقعة:

  • README 已生成，包含：
  • - 專案標題與描述
  • - 安裝指示（pip、conda）
  • - 含範例的快速入門指南
  • - 設定選項表格
  • - 授權與貢獻指南

التدقيق الأمني

آمن
v1 • 2/25/2026

All 91 static findings are false positives triggered by documentation examples in the skill. The skill provides templates and examples for generating documentation. No actual code execution, network calls, or credential access occurs. Risk level: SAFE.

2
الملفات التي تم فحصها
692
الأسطر التي تم تحليلها
1
النتائج
1
إجمالي عمليات التدقيق
مشكلات منخفضة المخاطر (1)
resources/implementation-playbook.md:1-641SKILL.md:1-51
Static Scanner Pattern Detection in Documentation Examples
The static scanner detected 91 potential security patterns in documentation examples. These findings are false positives triggered by template variables (${VARIABLE}), code block fences (```), and example URLs in the implementation playbook. No actual code execution, network calls, or credential access occurs.
تم تدقيقه بواسطة: claude

درجة الجودة

38
الهندسة المعمارية
100
قابلية الصيانة
87
المحتوى
50
المجتمع
100
الأمان
100
الامتثال للمواصفات

ماذا يمكنك بناءه

Web 服務的 API 文件

從 REST 端點程式碼自動生成 OpenAPI 規格與互動式 API 文件

專案 README 生成

建立包含安裝、使用範例與貢獻指南的完整 README 檔案

架構文件

從程式碼結構生成系統架構圖表與元件文件

جرّب هذه الموجهات

基本 API 文件 
為此程式碼庫中的端點生成 API 文件。包含請求/回應 schema、驗證需求與範例請求。
完整專案 README 
為此專案建立一份完整的 README.md。包含：專案描述、安裝步驟、使用範例、設定選項與貢獻指南。
架構概覽 
分析程式碼庫結構並生成架構文件。包含系統圖表、元件描述、資料流程與技術堆疊摘要。
文件自動化設定 
為此專案設定自動化文件生成。包含 CI/CD 設定、文件 linting 規則，以及部署至文件託管平台。

أفضل الممارسات

  • 務必透過測試驗證生成的文件符合實際程式碼行為
  • 使用 CI/CD 自動化讓文件與程式碼保持同步
  • 包含使用者可直接複製調整的實用程式碼範例

تجنب

  • 生成文件後未審核準確性
  • 在公開文件中包含 API 金鑰或內部 URL 等敏感資訊
  • 建立無法自動驗證或測試的文件

الأسئلة المتكررة

此技能可生成哪些類型的文件？
此技能可生成 API 文件、架構圖表、README 檔案、使用者指南與技術參考資料。它支援 OpenAPI/Swagger 規格、Mermaid 圖表與多種文件格式。
此技能會在我的專案上執行程式碼嗎？
否。此技能會分析您的程式碼以了解其結構，並據此生成文件。它不會修改或執行您的程式碼庫。
我可以將此與我的 CI/CD 管線整合嗎？
可以。此技能包含在 CI/CD 管線中設定自動化文件生成的指引，可使用 GitHub Actions、GitLab CI 或類似平台。
支援哪些程式設計語言？
此技能適用於任何程式設計語言。它會分析程式碼結構並生成與語言無關的文件。特定語言支援取決於文件格式（例如 JavaScript 的 JSDoc、Python 的 Docstrings）。
如何讓文件與我的程式碼保持同步？
在 CI 管線中設定自動文件生成，在每次提交時執行。您也可以使用文件 linting 工具在部署前捕捉不一致之處。
此技能可以為私人或內部 API 建立文件嗎？
可以。此技能可為任何 API 建立文件。但在外部分享前，請務必審核生成的文件，移除任何敏感的內部 URL、憑證或專屬資訊。

تفاصيل المطور

المؤلف

sickn33

الترخيص

MIT

المستودع

https://github.com/sickn33/antigravity-awesome-skills/tree/main/skills/code-documentation-doc-generate

مرجع

main

بنية الملفات

📁 resources/

📄 implementation-playbook.md

📄 SKILL.md