human-docs-generator
إنشاء توثيق مقروء تلقائياً
الأكواد المعقدة المولدة بالذكاء الاصطناعي وقرارات البنية المعمارية تحتاج إلى توثيق واضح يمكن لأعضاء الفريق المختلفين فهمه. تحول هذه المهارة الحالة التقنية إلى أدلة بسيطة خاصة بكل دور للمطورين وفرق ضمان الجودة وفرق العمليات وأصحاب المصلحة في الأعمال.
下載技能 ZIP
在 Claude 中上傳
前往 設定 → 功能 → 技能 → 上傳技能
開啟並開始使用
測試它
正在使用「human-docs-generator」。 إنشاء توثيق لميزة تسجيل الدخول بـ OAuth2 الجديدة
預期結果:
- Frontend Developer Guide - Authentication Section
- - Login component location: src/auth/Login.tsx
- - OAuth flow: Google → /auth/google/callback → JWT storage
- - State shape: { user, token, expiresAt }
- - Mermaid diagram showing auth flow
- End User Guide - Login Methods
- - Click 'Sign in with Google' button
- - Grant permissions in popup window
- - Redirected to dashboard on success
- - Troubleshooting: Clear cookies if issues occur
正在使用「human-docs-generator」。 إنشاء توثيق تأهيل لمطوري الخلفية الجدد
預期結果:
- Backend Developer Guide - Quick Start
- - Run: npm install then npm run dev
- - API available at http://localhost:3000
- - Database connection required before starting
- Component Map
- - Routes: auth, users, products, orders
- - Services: AuthService, UserService, ProductService
- - Models: User, Product, Order (PostgreSQL)
- - Mermaid diagram of service dependencies
安全審計
安全This is a pure documentation skill with no executable code. The SKILL.md contains only YAML frontmatter and Markdown describing documentation generation behavior. No network calls, filesystem access, command execution, or environment variable access. All 62 static findings are FALSE POSITIVES caused by the scanner misidentifying JSON key names, Markdown code block syntax, and documentation references as security patterns.
風險因素
🌐 網路存取 (1)
📁 檔案系統存取 (1)
⚙️ 外部命令 (25)
品質評分
你能建構什麼
توثيق قرارات البنية المعمارية
إنشاء توثيق تصميم النظام والأنماط لأعضاء الفريق الجدد وأصحاب المصلحة.
تأهيل المطورين الجدد
إنشاء أدلة البدء السريع وخرائط المكونات التي تساعد المطورين الجدد على فهم قاعدة الأكواد.
تتبع خرائط طريق الميزات
إنشاء توثيق الميزات وملخصات المقاييس لأصحاب المصلحة في الأعمال.
試試這些提示
Generate human docs for all roles (developers, QA, DevOps, product managers) based on recent changes in ai-state/active/ and ai-state/knowledge/. Include Mermaid diagrams for component relationships.
Create a frontend-developer.md guide showing component hierarchy, state management patterns, and recent UI changes. Use Mermaid graphs.
Create end-user-guide.md with step-by-step instructions, workflow diagrams, and screenshots descriptions for new features.
Update architect.md with new patterns, system design changes, and decision logs from ai-state/knowledge/decisions.md.
最佳實務
- تفعيل إنشاء التوثيق فوراً بعد إكمال المهمة الكبرى بينما السياق لا يزال حاضراً
- تضمين مخططات Mermaid لتقليل وقت القراءة وتحسين الفهم
- الحفاظ على كل مستند أقل من 1000 كلمة مع التركيز على الحالة الحالية وليس التاريخ
避免
- كتابة سجلات التغييرات بدلاً من توثيق الحالة الحالية
- تضمين تحليلات تقنية عميقة مخصصة للمطورين الآخرين
- استخدام جدران نصية بدون نقاط أو مخططات أو أمثلة