docs: sync consolidation and session starter
This commit is contained in:
37
docs/standards/DOC_TEMPLATE.md
Normal file
37
docs/standards/DOC_TEMPLATE.md
Normal file
@@ -0,0 +1,37 @@
|
||||
# <Document Title>
|
||||
|
||||
Date: YYYY-MM-DD
|
||||
Purpose: one-sentence objective of this document.
|
||||
|
||||
## Scope
|
||||
|
||||
- Systems, repos, services, and files covered.
|
||||
|
||||
## Preconditions
|
||||
|
||||
- Required access
|
||||
- Required tools
|
||||
- Required environment
|
||||
|
||||
## Procedure
|
||||
|
||||
1. Step one
|
||||
2. Step two
|
||||
3. Step three
|
||||
|
||||
## Verification
|
||||
|
||||
- Command(s):
|
||||
```bash
|
||||
# put verification commands here
|
||||
```
|
||||
- Expected result(s)
|
||||
|
||||
## Rollback
|
||||
|
||||
1. Recovery step one
|
||||
2. Recovery step two
|
||||
|
||||
## References
|
||||
|
||||
- `/absolute/or/repo/path/to/relevant/file`
|
||||
Reference in New Issue
Block a user