48 lines
836 B
Markdown
48 lines
836 B
Markdown
---
|
|
tags:
|
|
- Operations
|
|
- Index
|
|
- Documentation
|
|
---
|
|
|
|
# Foundations
|
|
## Purpose
|
|
Defines the baseline documentation standards, shared references, and structural conventions used everywhere else in this knowledgebase.
|
|
|
|
## Includes
|
|
- Documentation styling contract
|
|
- Inventory and naming conventions
|
|
- Shared templates and glossary references
|
|
|
|
## New Document Template
|
|
````markdown
|
|
# <Document Title>
|
|
## Purpose
|
|
<one paragraph describing why this exists>
|
|
|
|
!!! info "Assumptions"
|
|
- <OS / platform / privilege assumptions>
|
|
- <required tools or prerequisites>
|
|
|
|
## Scope
|
|
- <what is covered>
|
|
- <what is explicitly out of scope>
|
|
|
|
## Procedure
|
|
```sh
|
|
# Commands go here (grouped and annotated)
|
|
```
|
|
|
|
## Validation
|
|
- <command + expected result>
|
|
|
|
## Troubleshooting
|
|
### Symptoms
|
|
- <what you see>
|
|
|
|
### Resolution
|
|
```sh
|
|
# Fix steps
|
|
```
|
|
````
|