44 lines
1.2 KiB
Markdown
44 lines
1.2 KiB
Markdown
# [Pattern Name]
|
|
|
|
<!-- SCOPE: Pattern documentation ONLY. Contains principle (industry standard), implementation (project-specific), code structure patterns (DO/DON'T), sources. -->
|
|
<!-- DO NOT add here: Architectural decisions → ADR, Implementation code → Task descriptions, Multiple patterns → Separate guides, Requirements → Requirements.md, API specs → api_spec.md -->
|
|
|
|
## Principle
|
|
|
|
{{PRINCIPLE}}
|
|
|
|
(1-2 sentences describing the core industry best practice with version/date citation)
|
|
|
|
## Our Implementation
|
|
|
|
{{OUR_IMPLEMENTATION}}
|
|
|
|
(1 paragraph: how we apply this pattern in our project context, which layers/components affected, key integration points)
|
|
|
|
## Patterns
|
|
|
|
| Do This ✅ | Don't Do This ❌ | When to Use |
|
|
|-----------|------------------|-------------|
|
|
| {{PATTERN_1_DO}} | {{PATTERN_1_DONT}} | {{PATTERN_1_WHEN}} |
|
|
| {{PATTERN_2_DO}} | {{PATTERN_2_DONT}} | {{PATTERN_2_WHEN}} |
|
|
| {{PATTERN_3_DO}} | {{PATTERN_3_DONT}} | {{PATTERN_3_WHEN}} |
|
|
|
|
## Sources
|
|
|
|
- {{SOURCE_1}}
|
|
- {{SOURCE_2}}
|
|
- Internal: [Architecture.md](../project/architecture.md)
|
|
|
|
## Related
|
|
|
|
**ADRs:** {{RELATED_ADRS}}
|
|
**Guides:** {{RELATED_GUIDES}}
|
|
|
|
---
|
|
**Last Updated:** {{DATE}}
|
|
|
|
---
|
|
|
|
**Guide Template Version:** 4.0.0 (Minimal Format)
|
|
**Template Last Updated:** 2025-01-31
|