Generating SOP Guides — User Guide
Generating SOP Guides
Section titled “Generating SOP Guides”Quick Reference
- Who: AI Agent (via IDE)
- Where: AI Coding IDE
- Time: ~10-15 minutes
- Prerequisites: Knowledge layer (personas, JTBD, flows) recommended
Persona Context
Section titled “Persona Context”This guide is for: AI Agent Alex
Job To Be Done: Systematize codebase knowledge
What Makes SOPs Special
Section titled “What Makes SOPs Special”DocKit Master SOPs are not just step-by-step instructions. They include:
| Feature | Traditional SOP | DocKit Master SOP |
|---|---|---|
| Steps | Yes | Yes |
| Persona context | No | Who this guide is for |
| JTBD alignment | No | Why the user does this |
| Process flow | No | Mermaid workflow diagram |
| User journey | No | Satisfaction scoring |
| Troubleshooting | Sometimes | Always (progressive disclosure) |
| FAQ | Sometimes | Always (schema-ready for SEO) |
Process Flow
Section titled “Process Flow”graph TB
S(["Start: knowledge layer exists"])
A["Read sop-guide.md skill"]
B["Identify user-facing features"]
C["Group by module"]
D["Generate SOP per feature"]
E(["SOP files in docs/sop/"])
S --> A --> B --> C --> D --> E
Step-by-Step Guide
Section titled “Step-by-Step Guide”Step 1: Generate Knowledge Layer First
Section titled “Step 1: Generate Knowledge Layer First”SOP guides are enriched with personas, JTBD, and flows. If these do not exist, the SOP skill automatically runs the knowledge skills first.
Step 2: Invoke SOP Generation
Section titled “Step 2: Invoke SOP Generation”Use DOC_TYPE = sop or all in the configuration prompt.
Step 3: Review Each SOP
Section titled “Step 3: Review Each SOP”Each SOP file should contain these sections in order:
- Quick Reference card
- Persona Context (linked to persona + JTBD)
- Process Flow (inline Mermaid diagram)
- Prerequisites checklist
- Numbered step-by-step guide
- Expected Results
- Troubleshooting (in
<details>tags) - FAQ (H3 questions under H2 FAQ)