architecture-docs
starsforks
How to install architecture-docs?
girijashankarj/cursor-handbook/architecture-docs
$npx -y skills add girijashankarj/cursor-handbook --skill architecture-docsWorkflow for creating and maintaining architecture documentation. Use when the user needs to document system architecture or make ADRs.
SKILL.md
| 1 | # Skill: Create Architecture Documentation |
| 2 | |
| 3 | ## Trigger |
| 4 | When the user needs to document system architecture or make Architecture Decision Records (ADRs). |
| 5 | |
| 6 | ## Prerequisites |
| 7 | - [ ] Codebase or design available to analyze |
| 8 | - [ ] docs/ or docs/architecture/ directory exists (or create it) |
| 9 | - [ ] Mermaid support in docs (GitHub, MkDocs, etc.) |
| 10 | |
| 11 | ## Steps |
| 12 | |
| 13 | ### Step 1: System Overview |
| 14 | - [ ] High-level architecture diagram (Mermaid) |
| 15 | - [ ] List all services/components |
| 16 | - [ ] Document communication patterns |
| 17 | - [ ] Document data flow |
| 18 | |
| 19 | ### Step 2: Component Documentation |
| 20 | For each service/component: |
| 21 | - [ ] Purpose and responsibilities |
| 22 | - [ ] Technology stack |
| 23 | - [ ] API contracts (if applicable) |
| 24 | - [ ] Data stores |
| 25 | - [ ] Dependencies |
| 26 | - [ ] Scaling characteristics |
| 27 | |
| 28 | ### Step 3: Architecture Decision Records (ADRs) |
| 29 | For significant decisions: |
| 30 | - [ ] Title: Short descriptive title |
| 31 | - [ ] Status: Proposed / Accepted / Deprecated / Superseded |
| 32 | - [ ] Context: Why this decision is needed |
| 33 | - [ ] Decision: What was decided |
| 34 | - [ ] Consequences: Trade-offs and implications |
| 35 | |
| 36 | ADR template: |
| 37 | ```markdown |
| 38 | # ADR-{number}: {title} |
| 39 | |
| 40 | ## Status |
| 41 | {Proposed | Accepted | Deprecated | Superseded by ADR-{n}} |
| 42 | |
| 43 | ## Context |
| 44 | {What is the issue that we're seeing that is motivating this decision?} |
| 45 | |
| 46 | ## Decision |
| 47 | {What is the change that we're proposing and/or doing?} |
| 48 | |
| 49 | ## Consequences |
| 50 | {What becomes easier or harder because of this change?} |
| 51 | ``` |
| 52 | |
| 53 | ### Step 4: Data Flow Diagrams |
| 54 | - [ ] Request flow through the system |
| 55 | - [ ] Event/message flow |
| 56 | - [ ] Data pipeline flow |
| 57 | - [ ] Authentication flow |
| 58 | |
| 59 | ### Step 5: Operational Documentation |
| 60 | - [ ] Deployment architecture |
| 61 | - [ ] Monitoring and alerting overview |
| 62 | - [ ] Disaster recovery plan |
| 63 | - [ ] Scaling procedures |
| 64 | |
| 65 | ## Completion Checklist |
| 66 | - [ ] At least one diagram (Mermaid) for system or data flow |
| 67 | - [ ] ADRs for significant decisions (format, status, context, decision, consequences) |
| 68 | - [ ] Component list with purpose and tech stack |
| 69 | - [ ] Operational section (deploy, monitor, scale) |
| 70 | |
| 71 | ## If Step Fails |
| 72 | - **Step 1 (overview)**: Start with 3–5 boxes; add detail later. Use `flowchart LR` or `flowchart TB` for simple flows |
| 73 | - **Step 3 (ADRs)**: Number format `ADR-001`; keep each ADR to one decision |
| 74 | - **Step 4 (diagrams)**: Mermaid syntax: no spaces in node IDs; use `A[Label]` not `A[Label with spaces]` |
| 75 | |
| 76 | ## Example |
| 77 | Step 1: `flowchart LR` with Client -> API -> DB, API -> Cache. Step 3: ADR-001 Use PostgreSQL — Status Accepted, Context: need relational, Decision: PostgreSQL, Consequences: SQL expertise required. |
People who liked this also viewed
6 picksType
- grill-with-docsA relentless interview to sharpen a plan or design, which also creates docs (ADR's and glossary) as we go.SkillsJul 2026
- lark-minutes飞书妙记：搜索妙记、查看妙记基础信息、下载/上传音视频、读取或编辑妙记的产物内容、改标题、替换说话人/关键词、申请妙记查看/编辑权限。当给出minute_token、本地音视频文件，要查/改/转妙记产物，或用户明确要主动申请妙记权限时使用；本地音视频转纪要/逐字稿优先走本 skill，不要用 ffmpeg/whisper 本地转写。不负责：获取会议关联妙记，或仅按自然语言标题定位纪要SkillsJul 2026
- lark-markdown飞书 Markdown：查看、创建、上传、编辑和比较 Markdown 文件。当用户需要创建或编辑 Markdown 文件、读取、修改、局部 patch 或比较差异时使用。不负责将 Markdown 导入为飞书在线文档，也不负责文件搜索、权限、评论、移动、删除等云空间管理操作。SkillsJul 2026
- docxUse this skill whenever the user wants to create, read, edit, or manipulate Word documents (.docx files) or Word templates (.dotx files). Triggers include: any mention of 'Word doc', 'word document', SkillsJul 2026
- edit-articleSkills for Real Engineers. Straight from my .agents directory.SkillsJul 2026
- lark-note飞书会议纪要（Note）直查：已知 note_id 时查询纪要详情、展示类型、关联文档 token，并读取 unified 原始逐字记录。当用户已持有 note_id，或从文档显式 vc-node-id 获得 note_id 时使用。不负责会议/日程/妙记定位、文档标题搜索或 Docx 正文读取。SkillsJul 2026
