技能 documentation-templates
📦

documentation-templates

安全

إنشاء وثائق احترافية بسرعة

توفر هذه المهارة قوالب جاهزة للاستخدام لملفات README، ووثائق API، وتعليقات الكود، وسجلات التغيير، وتنسيقات الوثائق الصديقة للذكاء الاصطناعي.

支持: Claude Codex Code(CC)
🥉 74 青铜
1

下载技能 ZIP

2

在 Claude 中上传

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

3

开启并开始使用

测试它

正在使用“documentation-templates”。 استخدم documentation-templates لإنشاء README لـ Node.js API

预期结果:

ملف README.md كامل مع الأقسام: العنوان + ملخص موجز، Quick Start، الميزات، جدول التكوين، رابط مرجع API، إرشادات المساهمة، الترخيص

正在使用“documentation-templates”。 استخدم documentation-templates لتوثيق نقطة نهاية GET /users

预期结果:

وثائق API مع وصف نقطة النهاية، جدول المعاملات (id: string، مطلوب)، رموز الاستجابة (200، 404)، ومثال على الطلب/الاستجابة

正在使用“documentation-templates”。 استخدم documentation-templates لإنشاء ADR لاختيار قاعدة البيانات

预期结果:

مستند ADR مع الحالة (Accepted/Deprecated/Superseded)، السياق (لماذا القرار مطلوب)، القرار (ما تم تقريره)، العواقب (المقايضات)

安全审计

安全
v1 • 2/24/2026

All 23 static findings are false positives. The skill contains only markdown documentation templates with no executable code. The detected patterns (external_commands, weak cryptographic algorithms, system reconnaissance) are markdown code fences, plain English text, and API documentation placeholders - not actual security risks.

1
已扫描文件
200
分析行数
0
发现项
1
审计总数
未发现安全问题

检测到的模式

External Command Execution (False Positive)Weak Cryptographic Algorithm (False Positive)System Reconnaissance (False Positive)
审计者: claude

质量评分

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

你能构建什么

إعداد مشروع جديد

إنشاء هيكل الوثائق بسرعة لمشروع جديد مع قوالب README ووثائق API وسجل التغيير.

معايير الوثائق

الحفاظ على أسلوب وثائق متسق عبر مشاريع الفريق باستخدام قوالب موحدة.

تكامل وكيل الذكاء الاصطناعي

إنشاء وثائق يمكن لوكلاء الذكاء الاصطناعي مثل Claude و Codex فهمها واستخدامها بفعالية.

试试这些提示

إنشاء README أساسي 
استخدم مهارة documentation-templates لإنشاء README.md لمشروع [project type] الخاص بي. قم بتضمين أقسام Quick Start و Features و Configuration.
توثيق نقاط نهاية API 
استخدم مهارة documentation-templates لإنشاء وثائق API لـ REST API الخاص بي مع نقاط النهاية [list endpoints].
كتابة تعليقات الكود 
استخدم مهارة documentation-templates لإضافة تعليقات JSDoc إلى الدالة الخاصة بي التي [describe function purpose].
إنشاء سجل قرار الهندسة المعمارية 
استخدم مهارة documentation-templates لإنشاء ADR لـ [decision title]. قم بتضمين أقسام Context و Decision و Consequences.

最佳实践

  • ابدأ بالأقسام الأساسية أولاً (العنوان، البدء السريع، الميزات) قبل إضافة الوثائق التفصيلية
  • استخدم القوالب كنقاط بداية وقم بتكييف الهيكل مع احتياجات مشروعك
  • حافظ على تحديث الوثائق - الوثائق القديمة أسوأ من عدم وجود وثائق
  • قم بتضمين أمثلة في وثائقك لمساعدة المستخدمين على الفهم بسرعة

避免

  • لا تنسخ القوالب حرفيًا دون تخصيصها لسياق مشروعك
  • تجنب توثيق تفاصيل التنفيذ في ملفات README الموجهة للمستخدم
  • لا تتخطى قسم Quick Start - يريد المستخدمون البدء بسرعة
  • تجنب استخدام تنسيقات الوثائق القديمة التي لا يمكن لوكلاء الذكاء الاصطناعي تحليلها

常见问题

ما الأدوات المتوافقة مع هذه المهارة؟
تعمل هذه المهارة مع Claude و Codex و Claude Code. استخدمها مع أدوات Read و Glob و Grep.
هل أحتاج إلى تعديل القوالب؟
نعم، القوالب هي نقاط بداية. قم بتكييف العناصر النائبة والهيكل لتناسب احتياجات مشروعك المحددة.
هل يمكنني استخدام هذا للمشاريع التجارية؟
نعم، هذه المهارة مرخصة بموجب MIT، مما يسمح بالاستخدام التجاري مع الإسناد.
ما هو llms.txt؟
llms.txt هو تنسيق وثائق مصمم لزواحف ووكلاء الذكاء الاصطناعي. يوفر نظرة عامة منظمة يمكن لنماذج الذكاء الاصطناعي تحليلها وفهمها بسهولة.
كيف يختلف هذا عن الوثائق التي تم إنشاؤها تلقائيًا؟
توفر هذه المهارة قوالب مكتوبة يدويًا تعطي الأولوية للوضوح والقابلية للمسح الضوئي. غالبًا ما تفتقر الوثائق التي يتم إنشاؤها تلقائيًا إلى الهيكل والسياق المناسبين.
هل يمكن لهذه المهارة توليد كود فعلي؟
لا، توفر هذه المهارة فقط هياكل وقوالب الوثائق. لا تنتج كودًا قابلًا للتنفيذ.

开发者详情

作者

sickn33

许可证

MIT

仓库

https://github.com/sickn33/antigravity-awesome-skills/tree/main/skills/documentation-templates

引用

main

文件结构

📄 SKILL.md