spitoglou/fabric-claude-skills · Archived

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 de…

First seen Feb 2, 2026

Installation

$ npx skills add spitoglou/fabric-claude-skills --skill technical-documentation

Summary

  • 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".

Stronger alternatives

This repository is archived — consider an actively maintained alternative.

Similar popular skills

Related neighbors and high-traction skills in the same topics — useful to compare before installing.

Also in this package

Other skills from spitoglou/fabric-claude-skills.

npx skills add spitoglou/fabric-claude-skills

Browse all from spitoglou/fabric-claude-skills

More details

Agent compatibility

Declared targets from SKILL.md / docs. Unmarked agents are not listed — the skill may still install via the CLI.

Claude Code Not declared
Cursor Not declared
Codex Not declared
GitHub Copilot Not declared
Windsurf Not declared
Gemini CLI Not declared
Cline Not declared
OpenCode Not declared

Repository health

Stars 3
License LICENSE
Default branch master
Open issues 0
Status Archived

Package contents

Files included with this skill beyond the listing page.

  • skill md SKILL.md 3,262 B
  • docs SUMMARY.md 541 B

History

  1. First seen on skills.sh
  2. First recorded snapshot · 15 installs

SKILL.md

Technical Documentation

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

Pattern Selection

Intent Pattern When to Use
System architecture createdesigndocument New system design, C4 model, security posture
Improve existing design refinedesigndocument 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 createuserstory 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 writepullrequest Summarize code changes for review
Git summaries summarizegitdiff Explain what changed in commits

Decision flow:

  1. New system/feature? → createdesigndocument or create_prd
  2. Existing design needs work? → refinedesigndocument or review_design
  3. Code to explain? → explain_code
  4. Need visuals? → create_mermaid
  5. Agile artifacts? → createuserstory
  6. Git/PR work? → writepullrequest or summarizegitdiff

Pattern References

See references/ for full patterns:

  • [createdesigndocument.md](references/createdesigndocument.md) - C4 architecture docs
  • [createprd.md](references/createprd.md) - Product requirements
  • [createuserstory.md](references/createuserstory.md) - Agile stories
  • [explaincode.md](references/explaincode.md) - Code walkthroughs
  • [createmermaid.md](references/createmermaid.md) - Diagram generation
  • [writepullrequest.md](references/writepullrequest.md) - PR descriptions
  • [reviewdesign.md](references/reviewdesign.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 createprd → offer createdesign_document for implementation
  • After createdesigndocument → offer create_mermaid for diagrams
  • After explain_code → offer to generate documentation or tests
  • After reviewdesign → offer refinedesign_document to address issues