Operational Note Block
Document known issues, workarounds, and operational procedures. Capture symptoms, recommended actions, and risk levels for operations teams.
Operational notes document known issues, workarounds, and procedures that operations teams need to know. They bridge the gap between architecture documentation and runbooks, capturing the tribal knowledge that keeps systems running. Displayed with colour-coded severity for quick identification.
When to Use
Block Properties
| Property | Required | Description |
|---|---|---|
| Title | Yes | Short name for the note |
| Description | Yes | Detailed explanation of the issue or procedure |
| Environment | No | Which environment: production, staging, development, or all |
| Applies To | No | Which service or component this affects |
| Symptoms | No | Array of observable indicators |
| Recommended Action | No | What to do when encountering this situation |
| Workarounds | No | Temporary fixes until a proper solution is available |
| Impact | No | Consequences if not addressed |
| Risk Level | No | Severity: low, medium, or high |
| Status | No | Current state: active, informational, or obsolete |
| Last Observed | No | When the issue was last seen |
| Review Date | No | When to review this note |
| Notes | No | Additional context or observations |
Environment Values
Risk Level Values
Example: Known Issue
Documenting a known bug with workaround.
Example: Operational Procedure
Documenting a routine operational task.
Example: Troubleshooting Tip
Capturing knowledge for on-call engineers.
Example: Environment-Specific Note
A note that only applies to staging environment.