technical-documentation

Create and improve technical documentation including architecture designs, PRDs, API docs, code explanations, and visual diagrams. Use when asked to document systems, explain codebases, create design documents, write PRDs, generate Mermaid/PlantUML diagrams, review architecture, write user stories, or create pull request descriptions. Triggers include "document this", "create a design doc", "explain this code", "write a PRD", "create a diagram", "architecture overview", "user story for", "PR description".

Safety Notice

This listing is imported from skills.sh public index metadata. Review upstream SKILL.md and repository scripts before running.

Copy this and send it to your AI assistant to learn

Install skill "technical-documentation" with this command: npx skills add spitoglou/fabric-claude-skills/spitoglou-fabric-claude-skills-technical-documentation

Technical Documentation

Generate professional technical documentation from specifications, code, or requirements.

Pattern Selection

IntentPatternWhen to Use
System architecturecreate_design_documentNew system design, C4 model, security posture
Improve existing designrefine_design_documentEnhance clarity, fill gaps in design docs
Review architecturereview_designEvaluate designs for scalability, security
Product requirementscreate_prdFeature specs, product planning
User storiescreate_user_storyAgile stories with acceptance criteria
Code explanationexplain_codeUnderstand codebases, configs, tool outputs
Doc improvementexplain_docsTransform technical docs into clearer versions
Visual diagramscreate_mermaidFlowcharts, sequence diagrams, ERDs
PR descriptionswrite_pull_requestSummarize code changes for review
Git summariessummarize_git_diffExplain what changed in commits

Decision flow:

  1. New system/feature? → create_design_document or create_prd
  2. Existing design needs work? → refine_design_document or review_design
  3. Code to explain? → explain_code
  4. Need visuals? → create_mermaid
  5. Agile artifacts? → create_user_story
  6. Git/PR work? → write_pull_request or summarize_git_diff

Pattern References

See references/ for full patterns:

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 → offer create_design_document for implementation
  • After create_design_document → offer create_mermaid for diagrams
  • After explain_code → offer to generate documentation or tests
  • After review_design → offer refine_design_document to address issues

Source Transparency

This detail page is rendered from real SKILL.md content. Trust labels are metadata-based hints, not a safety guarantee.

Open in GitHubOpen in ClawHub

Related Skills

Related by shared tags or category signals.

General

learning-education

No summary provided by upstream source.

Repository SourceNeeds Review
12-spitoglou
General

critical-thinking

No summary provided by upstream source.

Repository SourceNeeds Review
7-spitoglou
Research

research-intelligence

No summary provided by upstream source.

Repository SourceNeeds Review
6-spitoglou
General

content-transformation

No summary provided by upstream source.

Repository SourceNeeds Review
5-spitoglou