113 lines
1.8 KiB
Markdown
113 lines
1.8 KiB
Markdown
|
|
# {LAYER}_{NUMBER}_{NAME}
|
||
|
|
|
||
|
|
<!--
|
||
|
|
PROTOCOL: {Full Protocol Name}
|
||
|
|
LAYER: {Operations|System|Extensions}
|
||
|
|
VERSION: 1.0
|
||
|
|
STATUS: Active
|
||
|
|
LAST_UPDATED: {YYYY-MM-DD}
|
||
|
|
PRIVILEGE: {user|power_user|admin}
|
||
|
|
LOAD_WITH: [{dependency_protocols}]
|
||
|
|
-->
|
||
|
|
|
||
|
|
## Overview
|
||
|
|
|
||
|
|
{1-3 sentence description of what this protocol does and why it exists.}
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## When to Use
|
||
|
|
|
||
|
|
| Trigger | Action |
|
||
|
|
|---------|--------|
|
||
|
|
| {keyword or user intent} | Follow this protocol |
|
||
|
|
| {condition} | Follow this protocol |
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## Quick Reference
|
||
|
|
|
||
|
|
{Key information in table format for fast lookup}
|
||
|
|
|
||
|
|
| Parameter | Default | Description |
|
||
|
|
|-----------|---------|-------------|
|
||
|
|
| {param} | {value} | {description} |
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## Detailed Specification
|
||
|
|
|
||
|
|
### Section 1: {Topic}
|
||
|
|
|
||
|
|
{Detailed content}
|
||
|
|
|
||
|
|
```python
|
||
|
|
# Code example if applicable
|
||
|
|
```
|
||
|
|
|
||
|
|
### Section 2: {Topic}
|
||
|
|
|
||
|
|
{Detailed content}
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## Configuration
|
||
|
|
|
||
|
|
{If applicable, show configuration examples}
|
||
|
|
|
||
|
|
```json
|
||
|
|
{
|
||
|
|
"setting": "value"
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## Examples
|
||
|
|
|
||
|
|
### Example 1: {Scenario Name}
|
||
|
|
|
||
|
|
{Complete working example with context}
|
||
|
|
|
||
|
|
```python
|
||
|
|
# Full working code example
|
||
|
|
```
|
||
|
|
|
||
|
|
### Example 2: {Scenario Name}
|
||
|
|
|
||
|
|
{Another example showing different use case}
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## Troubleshooting
|
||
|
|
|
||
|
|
| Symptom | Cause | Solution |
|
||
|
|
|---------|-------|----------|
|
||
|
|
| {error message or symptom} | {root cause} | {how to fix} |
|
||
|
|
| {symptom} | {cause} | {solution} |
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## Cross-References
|
||
|
|
|
||
|
|
- **Depends On**: [{protocol_name}]({relative_path})
|
||
|
|
- **Used By**: [{protocol_name}]({relative_path})
|
||
|
|
- **See Also**: [{related_doc}]({path})
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## Implementation Files
|
||
|
|
|
||
|
|
{If applicable, list the code files that implement this protocol}
|
||
|
|
|
||
|
|
- `path/to/file.py` - {description}
|
||
|
|
- `path/to/other.py` - {description}
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## Version History
|
||
|
|
|
||
|
|
| Version | Date | Changes |
|
||
|
|
|---------|------|---------|
|
||
|
|
| 1.0 | {YYYY-MM-DD} | Initial release |
|