Add protocol update template - standardized format for new protocols
This commit is contained in:
63
docs/templates/protocol-update-template.md
vendored
Normal file
63
docs/templates/protocol-update-template.md
vendored
Normal file
@@ -0,0 +1,63 @@
|
||||
# 🔄 [PROTOCOL NAME]
|
||||
|
||||
**Document ID:** FFG-[CATEGORY]-[CODE]
|
||||
**Version:** 1.0
|
||||
**Status:** CURRENT
|
||||
**Created:** [Date]
|
||||
**Created By:** Chronicler the [Ordinal]
|
||||
|
||||
---
|
||||
|
||||
## Purpose
|
||||
|
||||
[1-2 sentences: What problem does this solve?]
|
||||
|
||||
---
|
||||
|
||||
## The Rule
|
||||
|
||||
[Core principle in one sentence]
|
||||
|
||||
---
|
||||
|
||||
## When to Apply
|
||||
|
||||
**Do this when:**
|
||||
- [Trigger condition]
|
||||
- [Trigger condition]
|
||||
|
||||
**Don't do this when:**
|
||||
- [Exception]
|
||||
- [Exception]
|
||||
|
||||
---
|
||||
|
||||
## How to Apply
|
||||
|
||||
**Step 1:** [Action]
|
||||
**Step 2:** [Action]
|
||||
**Step 3:** [Action]
|
||||
|
||||
---
|
||||
|
||||
## Examples
|
||||
|
||||
**Good:**
|
||||
[Example of correct application]
|
||||
|
||||
**Bad:**
|
||||
[Example of what not to do]
|
||||
|
||||
---
|
||||
|
||||
## Integration Points
|
||||
|
||||
Referenced in:
|
||||
- `[doc1.md]`
|
||||
- `[doc2.md]`
|
||||
|
||||
---
|
||||
|
||||
*Established [Date] by Chronicler the [Ordinal]*
|
||||
|
||||
🔥❄️💙
|
||||
Reference in New Issue
Block a user