technical-documentation
4
总安装量
4
周安装量
#50555
全站排名
安装命令
npx skills add https://github.com/spitoglou/fabric-claude-skills --skill technical-documentation
Agent 安装分布
codex
3
opencode
3
trae
2
gemini-cli
2
claude-code
2
github-copilot
2
Skill 文档
Technical Documentation
Generate professional technical documentation from specifications, code, or requirements.
Pattern Selection
| Intent | Pattern | When to Use |
|---|---|---|
| System architecture | create_design_document |
New system design, C4 model, security posture |
| Improve existing design | refine_design_document |
Enhance clarity, fill gaps in design docs |
| Review architecture | review_design |
Evaluate designs for scalability, security |
| Product requirements | create_prd |
Feature specs, product planning |
| User stories | create_user_story |
Agile stories with acceptance criteria |
| Code explanation | explain_code |
Understand codebases, configs, tool outputs |
| Doc improvement | explain_docs |
Transform technical docs into clearer versions |
| Visual diagrams | create_mermaid |
Flowcharts, sequence diagrams, ERDs |
| PR descriptions | write_pull_request |
Summarize code changes for review |
| Git summaries | summarize_git_diff |
Explain what changed in commits |
Decision flow:
- New system/feature? â
create_design_documentorcreate_prd - Existing design needs work? â
refine_design_documentorreview_design - Code to explain? â
explain_code - Need visuals? â
create_mermaid - Agile artifacts? â
create_user_story - Git/PR work? â
write_pull_requestorsummarize_git_diff
Pattern References
See references/ for full patterns:
- create_design_document.md – C4 architecture docs
- create_prd.md – Product requirements
- create_user_story.md – Agile stories
- explain_code.md – Code walkthroughs
- create_mermaid.md – Diagram generation
- write_pull_request.md – PR descriptions
- review_design.md – Architecture review
Output Guidelines
- Use consistent heading hierarchy (H1 for title, H2 for sections)
- Include diagrams where they add clarity (Mermaid preferred)
- For code: always specify language in fenced blocks
- For designs: address security, scalability, and failure modes
- Keep PRDs focused on what, not how (implementation details in design docs)
Chaining Patterns
Offer logical follow-ups:
- After
create_prdâ offercreate_design_documentfor implementation - After
create_design_documentâ offercreate_mermaidfor diagrams - After
explain_codeâ offer to generate documentation or tests - After
review_designâ offerrefine_design_documentto address issues