common-skills/skills/deep-dive/assets/report-template.md

Deep Dive Report: {SUBJECT}

Generated by the deep-dive skill. Date: {DATE} Source: {SOURCE}

---

1. Overview

• What it is:
• Problem it solves:
• Target users:
• Design philosophy:
• Tech stack:

---

2. Architecture

{description of high-level structure}

@startuml
' Replace with actual components
package "Layer A" {
  [Component 1]
}
package "Layer B" {
  [Component 2]
  [Component 3]
}
[Component 1] --> [Component 2] : protocol
[Component 2] --> [Component 3] : protocol
@enduml

---

3. Key Concepts & Terminology

Term — definition and why it matters in this system.

---

4. Data Model

{description of primary entities and relationships}

@startuml
entity EntityA {
  * id : UUID
  --
  field : Type
}
entity EntityB {
  * id : UUID
  --
  field : Type
}
EntityA ||--o{ EntityB : relationship
@enduml

---

5. Core Flows & Sequences

Flow 1: {Name}

{one-paragraph description}

@startuml
actor User
participant "Component A" as A
participant "Component B" as B

User -> A : action
A -> B : call
B --> A : response
A --> User : result
@enduml

---

6. Public API / Interface Reference

Method	Path / Signature	Purpose	Key Params	Returns
GET	/resource	description	param	type

Auth: {mechanism}

---

7. Configuration & Deployment

Key config options:

Variable	Default	Description
ENV_VAR	value	what it controls

Run locally:

# minimal steps

Deployment topology: {description}

---

8. Extension & Integration Points

• {plugin/hook/middleware description}
• {how to add a new feature}
• {external integration patterns}

---

9. Observability

• Logging:
• Metrics:
• Tracing:
• Health check:

---

10. Known Limitations & Trade-offs

• {limitation or trade-off}

---

11. Further Reading

1. [Topic] — why it matters and where to find it
2. [Topic] — why it matters and where to find it
3. [Topic] — why it matters and where to find it