Element Spec: {Element Name}
Standard: project-standards.md Replace all
{placeholders}and remove this note before committing.
Identity
| Property | Value |
|---|---|
| Name | {element-name} |
| Type | server / service / saas / tool / script / network / automation |
| Category | compute / database / monitoring / messaging / proxy / storage / ai / ci-cd |
| Host / Provider | {vps-label} or {SaaS provider} |
| Status | active / planned / deprecated |
| Criticality | critical / high / medium / low |
| Added | YYYY-MM-DD |
| Last reviewed | YYYY-MM-DD |
Description
What this element does, why we have it, and what depends on it.
Connections
Depends on:
{element}— {why}
Used by:
{element}— {why}
External integrations:
{service}at{url/endpoint}— {purpose}
Compliance Status
| Requirement | Status | Notes |
|---|---|---|
| Workbook | yes / partial / no | {link or note} |
| Monitoring | yes / partial / no | {alert names} |
| Backup | yes / partial / no | {destination, frequency} |
| Restore | yes / partial / no | {last tested} |
| Healthcheck | yes / partial / no | {method} |
| Password rotation | yes / partial / no | {frequency} |
Credentials
Key names only — values NEVER in this file.
| Key name | Stored in | Rotation due | Purpose |
|---|---|---|---|
{KEY_NAME} | {location} | {date or N/A} | {purpose} |
Exceptions
Requirements this element cannot fully meet, with justification.
| Requirement | Gap | Reason | Compensating control | Target date |
|---|---|---|---|---|
| {requirement} | partial / no | {technical or business reason} | {what we do instead} | {date or N/A} |
Links
- Workbook:
docs/{service}-operations.md - Compose:
services/{name}/docker-compose.yml - Compliance:
services/compliance-matrix.yml - Runbook (if separate):
{link}