Compétences code-documentation-doc-generate
📦

code-documentation-doc-generate

Sûr

إنشاء توثيق الكود تلقائياً

إنشاء وثائق API شاملة، ومخططات الهندسة، وأدلة المستخدم، والمراجع التقنية من الكود المصدري باستخدام التحليل القائم على الذكاء الاصطناعي.

Prend en charge: Claude Codex Code(CC)
🥉 75 Bronze
1

Télécharger le ZIP du skill

2

Importer dans Claude

Allez dans Paramètres → Capacités → Skills → Importer un skill

3

Activez et commencez à utiliser

Tester

Utilisation de "code-documentation-doc-generate". Generate API documentation for a FastAPI user service with endpoints for create, read, update, delete users

Résultat attendu:

  • API Documentation created with:
  • - OpenAPI 3.0 specification
  • - User endpoints (/users, /users/{id})
  • - Request/response schemas with validation
  • - Authentication and authorization sections
  • - Example curl commands for each endpoint

Utilisation de "code-documentation-doc-generate". Create a README for a Python CLI tool that converts images to PDF

Résultat attendu:

  • README generated with:
  • - Project title and description
  • - Installation instructions (pip, conda)
  • - Quick start guide with examples
  • - Configuration options table
  • - License and contribution guidelines

Audit de sécurité

Sûr
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
Fichiers analysés
692
Lignes analysées
1
résultats
1
Total des audits
Problèmes à risque faible (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.
Audité par: claude

Score de qualité

38
Architecture
100
Maintenabilité
87
Contenu
50
Communauté
100
Sécurité
100
Conformité aux spécifications

Ce que vous pouvez construire

توثيق API لخدمات الويب

إنشاء مواصفات OpenAPI والوثائق التفاعلية API تلقائياً من كود نقاط النهاية REST

إنشاء README للمشروع

إنشاء ملفات README شاملة مع أمثلة التثبيت والاستخدام وإرشادات المساهمة

توثيق الهندسة

إنشاء مخططات هندسة النظام وتوثيق المكونات من هيكل الكود

Essayez ces prompts

توثيق API الأساسي 
إنشاء توثيق API لنقاط النهاية في هذا الكود المصدري. قم بتضمين مخططات الطلب/الاستجابة، ومتطلبات المصادقة، وأمثلة الطلبات.
README المشروع الكامل 
إنشاء README.md شامل لهذا المشروع. قم بتضمين: وصف المشروع، خطوات التثبيت، أمثلة الاستخدام، خيارات التكوين، وإرشادات المساهمة.
نظرة عامة على الهندسة 
تحليل هيكل الكود المصدري وإنشاء توثيق هندسي. قم بتضمين مخطط النظام، ووصف المكونات، وتدفقات البيانات، وملخص تقنية التطوير.
إعداد أتمتة التوثيق 
إعداد توليد التوثيق التلقائي لهذا المشروع. قم بتضمين تكوين CI/CD، وقواعد تدقيق التوثيق، والنشر إلى منصة استضافة التوثيق.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Bonnes pratiques
 
  •  Always verify generated documentation matches actual code behavior through testing
  •  Keep documentation synchronized with code using CI/CD automation
  •  Include practical code examples that users can copy and adapt
 
 
Éviter
 
  •  Generating documentation without reviewing for accuracy
  •  Including sensitive information like API keys or internal URLs in public docs
  •  Creating documentation that cannot be verified or tested automatically
 
 
Foire aux questions
 
What types of documentation can this skill generate?  
This skill can generate API documentation, architecture diagrams, README files, user guides, and technical references. It supports OpenAPI/Swagger specs, Mermaid diagrams, and various documentation formats.
Does this skill execute code on my project?  
No. This skill analyzes your code to understand its structure and generates documentation based on that analysis. It does not modify or execute your codebase.
Can I integrate this with my CI/CD pipeline?  
Yes. The skill includes guidance for setting up automated documentation generation in CI/CD pipelines using tools like GitHub Actions, GitLab CI, or similar platforms.
What programming languages are supported?  
The skill works with any programming language. It analyzes code structure and generates language-agnostic documentation. Specific language support depends on the documentation format (e.g., JSDoc for JavaScript, Docstrings for Python).
How do I keep documentation in sync with my code?  
Set up automated doc generation in your CI pipeline to run on each commit. You can also use doc linting tools to catch inconsistencies before deployment.
Can this skill document private or internal APIs?  
Yes. The skill can document any API. However, ensure you review generated documentation to remove any sensitive internal URLs, credentials, or proprietary information before sharing externally.
 
 
Détails du développeur
 
Auteur
 sickn33
 
Licence
 
MIT
 
Dépôt
 https://github.com/sickn33/antigravity-awesome-skills/tree/main/skills/code-documentation-doc-generate
 
Réf
 
main
 
Structure de fichiers
 
📁 resources/
 
📄 implementation-playbook.md
 
📄 SKILL.md