human-docs-generator
自動產生可讀性高的文件
複雜的 AI 生成程式碼與架構決策需要清楚的文件，讓不同團隊成員都能理解。這項技能將技術狀態轉換為簡潔、以角色為導向的指南，適用於開發者、QA、DevOps 與業務利害關係人。
下载技能 ZIP
在 Claude 中上传
前往 设置 → 功能 → 技能 → 上传技能
开启并开始使用
测试它
正在使用“human-docs-generator”。 Generate documentation for the new OAuth2 login feature
预期结果:
- 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”。 Generate onboarding docs for new backend developers
预期结果:
- 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)
质量评分
你能构建什么
記錄架構決策
為新團隊成員與利害關係人產生系統設計文件與模式。
新開發者上手
建立 quickstart 指南與元件地圖，協助新開發者理解程式碼庫。
追蹤功能路線圖
為業務利害關係人產生功能文件與指標摘要。
试试这些提示
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.
最佳实践
- 在 epic 完成後立即觸發文件產生，確保上下文仍然新鮮
- 加入 Mermaid 圖表以縮短閱讀時間並提升理解度
- 每份文件維持在 1000 字以內，聚焦當前狀態而非歷史
避免
- 撰寫變更記錄而非當前狀態文件
- 包含專為其他開發者撰寫的技術深度解析
- 使用大段文字，缺少條列、圖表或範例