技能 documentation-generator
📝

documentation-generator

安全 🌐 网络访问📁 文件系统访问⚙️ 外部命令

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

تستغرق كتابة الوثائق وقتًا كبيرًا ويتم إهمالها غالبًا. تعمل هذه المهارة على أتمتة إنشاء JSDoc و docstrings وملفات README والوثائق عبر لغات برمجة متعددة.

支持: Claude Codex Code(CC)
📊 69 充足
1

下载技能 ZIP

2

在 Claude 中上传

前往 设置 → 功能 → 技能 → 上传技能

3

开启并开始使用

测试它

正在使用“documentation-generator”。 وثق هذه الدالة: function calculateTotal(basePrice, taxRate, discount = 0)

预期结果:

  • تعليق JSDoc المُنشأ مع علامات @param و @returns و @throws
  • تضمين معلومات النوع لجميع المعاملات
  • إضافة مثال استخدام يُظهر المدخلات والمخرجات
  • توثيق شروط الأخطاء

正在使用“documentation-generator”。 إنشاء README لأداة CLI الخاصة بي

预期结果:

  • نظرة عامة كاملة على المشروع مع قائمة الميزات
  • تعليمات التثبيت لمستخدمي npm
  • أمثلة الاستخدام مع صيغة الأوامر
  • قسم مرجع API مع توثيق جميع الأوامر

安全审计

安全
v5 • 1/16/2026

This is a pure prompt-based skill containing only documentation generation instructions for AI assistants. The static scanner flagged metadata fields (source URLs, content hashes), markdown code examples (backticks in code fences), and documentation keywords as security issues. All 30 findings are false positives - no executable code, network calls, command execution, or file system access exists in this skill.

2
已扫描文件
354
分析行数
3
发现项
5
审计总数

风险因素

🌐 网络访问 (1)
skill-report.json:6
📁 文件系统访问 (1)
skill-report.json:117
⚙️ 外部命令 (11)
SKILL.md:48-62 SKILL.md:62-65 SKILL.md:65-84 SKILL.md:84-88 SKILL.md:88-94 SKILL.md:94-98 SKILL.md:98-111 SKILL.md:111-113 SKILL.md:113-117 SKILL.md:117-119 SKILL.md:119-134
审计者: claude 查看审计历史 →

质量评分

38
架构
100
可维护性
87
内容
21
社区
100
安全
83
规范符合性

你能构建什么

توثيق قواعد الكود الموجودة

إضافة وثائق شاملة للوظائف والأساليب غير الموثقة في المشاريع القديمة

إنشاء وثائق المشروع

إنشاء ملفات README ومراجع API وأدلة المساهمة للمستودعات العامة

توحيد تنسيق الوثائق

ضمان نمط وثائق متسق عبر لغات برمجة متعددة في المشروع

试试这些提示

الوثائق الأساسية 
استخدم مهارة documentation-generator لإنشاء تعليقات JSDoc لملف JavaScript التالي:
التوثيق بالتنسيق 
@documentation-generator --format google-style إنشاء docstrings Python لهذه الدالة مع تلميحات النوع والأمثلة:
إنشاء README فقط 
@documentation-generator --readme-only إنشاء README.md كامل لمشروعي يشمل الميزات والتثبيت والاستخدام ومرجع API:
مشروع متعدد اللغات 
استخدم documentation-generator لتوثيق جميع الوظائف في مجلد src/utils/. طبق التنسيق المناسب بناءً على امتداد الملف (JSDoc لـ .js/.ts، Google style لـ .py، Rustdoc لـ .rs):

最佳实践

  • توفير توقيعات الدوال الكاملة وأنواع المعاملات للحصول على وثائق دقيقة
  • مشاركة السياق ذي الصلة حول الحالات الخاصة واعتبارات الأداء
  • طلب الوثائق بأسلوبك الحالي للحصول على اتساق عبر قاعدة الكود

避免

  • طلب وثائق لكود بدون تعليقات أو هيكل واضح
  • توليد وثائق بدون مراجعة منطقية للأعمال
  • استخدام المهارة للكتابة فوق وثائق مخصصة تم إعدادها بعناية

常见问题

ما هي لغات البرمجة المدعومة؟
JavaScript/TypeScript (JSDoc)، Python (أنماط Google و NumPy و Sphinx)، Rust (Rustdoc)، Java (Javadoc)، و Go (GoDoc).
هل يمكن لهذه المهارة تعديل ملفات المصدر الخاصة بي؟
لا. تنشئ المهارة نص الوثائق الذي يمكنك نسخه ولصقه. ليس لديها وصول لنظام الملفات.
كيف تعرف المهارة نمط وثائق مشروعي؟
تستخدم الاصطلاحات القياسية لكل لغة. حدد نمطك المفضل أو شارك وثائق موجودة كمرجع.
هل بيانات الكود الخاصة بي آمنة؟
نعم. تعالج المهارة فقط الكود الذي تشاركه صراحة في المحادثة. لا يتم تخزين أي شيء أو إرساله إلى خدمات خارجية.
لماذا تبدو الوثائق مختلفة عن الكود الموجود لدي؟
تستخدم المهارة التنسيقات القياسية لكل لغة. قدم أمثلة من أسلوب مشروعك أو اطلب تنسيقًا محددًا.
كيف يختلف هذا عن اكتمال كود IDE؟
تنتج هذه المهارة وثائق شاملة مع أمثلة وسياق. تُضيف اكتمالات IDE عادةً توقيعات أساسية فقط.

开发者详情

许可证

MIT

仓库

https://github.com/CuriousLearner/devkit/tree/main/skills/documentation-generator

引用

main

文件结构

📄 SKILL.md