technical-documentation

spitoglou 的头像作者 spitoglou

创建和改进技术文档,包括架构设计、PRD、API文档、代码解释和视觉图表。当需要记录系统、解释代码库、创建设计文档、编写PRD、生成Mermaid/PlantUML图表、审查架构、编写用户故事或创建拉取请求描述时使用。触发词包括“记录这个”、“创建设计文档”、“解释这个代码”、“编写PRD”、“创建图表”、“架构概述”、“用户故事”、“PR描述”。

📖 中文导读:创建和改进技术文档,包括架构设计、PRD、API文档、代码解释和视觉图表。当需要记录系统、解释代码库、创建设计文档、编写PRD、生成Mermaid/PlantUML图表、审查架构、编写用户故事或创建拉取请求描述时使用。触发词包括“记录这个”、“创建设计文档”、“解释这个代码”、“编写PRD”、“创建图表”、“架构概述”、“用户故事”、“PR描述”。 以下正文为该技能的原始 SKILL.md 内容(英文),上方安装命令可直接使用。

name: technical-documentation description: 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".

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:

  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