technical-documentation
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
More from spitoglou/fabric-claude-skills
learning-education
Create learning materials, explain concepts, generate quizzes and study aids. Use when asked to explain topics, create tutorials, generate practice questions, make flashcards, design curricula, or help study. Triggers include "explain this", "help me learn", "create a quiz", "tutorial for", "study guide", "how does X work", "teach me", "practice questions".
33research-intelligence
Extract insights, analyze claims, and synthesize knowledge from research content. Use when processing academic papers, articles, podcasts, videos, meeting transcripts, or any content where the goal is to extract wisdom, analyze arguments, summarize findings, or compile references. Triggers include "analyze this paper", "extract key insights", "summarize the research", "what are the main claims", "extract wisdom from", "compile references", "critique this argument".
12critical-thinking
Analyze arguments, detect biases, evaluate claims, and improve reasoning. Use when asked to fact-check, identify logical fallacies, evaluate arguments, analyze predictions, find root causes, or think adversarially about plans. Triggers include "evaluate this argument", "logical fallacies", "fact check", "analyze the claims", "identify biases", "devil's advocate", "red team this", "root cause".
11writing-enhancement
Improve writing quality, fix errors, and transform style. Use when asked to proofread, edit, improve clarity, fix grammar/typos, enhance academic writing, analyze prose quality, humanize technical content, or write essays. Triggers include "improve this writing", "fix typos", "proofread", "make this clearer", "academic style", "humanize", "write an essay", "analyze my writing".
9content-creation
Create newsletters, social media posts, presentations, professional emails, and other content for publication or communication. Use when asked to write newsletters, draft emails, create social posts, design presentations, or prepare content for specific audiences. Triggers include "write a newsletter", "draft an email", "create a post", "social media", "presentation", "blog post", "LinkedIn", "announcement".
7content-transformation
Convert content between formats, summarize at different levels, and repurpose for various platforms. Use when asked to convert to markdown, create summaries of varying lengths, make tweets, create flashcards, or process video content. Triggers include "convert to markdown", "summarize in one sentence", "make this a tweet", "create flashcards", "TL;DR", "summarize this video", "export as CSV".
7