nicole
289769a601
Automatic Documentation Deployment / Sync Docs to https://kb.bunny-lab.io (push) Successful in 8s
37 lines
2.3 KiB
Markdown
37 lines
2.3 KiB
Markdown
---
|
|
tags:
|
|
- Documentation
|
|
- Information Architecture
|
|
- Reference
|
|
---
|
|
|
|
## Purpose
|
|
Keep Bunny Lab documentation discoverable by both its subject and its operational purpose. Topic guides connect the canonical documents across the five documentation roots.
|
|
|
|
## Choose the Document Role
|
|
| **Root** | **Primary Intent** |
|
|
| :--- | :--- |
|
|
| `Deployments` | Build or install the system |
|
|
| `Workflows` | Maintain, migrate, repair, or recover it |
|
|
| `Scripts` | Preserve a reusable operational utility |
|
|
| `Reference` | Explain concepts, inventory, architecture, and subject relationships |
|
|
| `Blog` | Preserve dated experience and the reasoning behind decisions |
|
|
|
|
## Choose the Subject
|
|
Use the same subject names across roots: Applications, Automation, Backup and Recovery, Containers, Identity and Certificates, Networking and Access, Virtualization and Storage, and Windows and Linux. Physical inventory and address plans belong in the Lab Map; authoring standards belong in Foundations.
|
|
|
|
## Connect the Knowledge
|
|
Link to the applicable prerequisite where it becomes necessary. Link a deployment to its independently useful maintenance procedures, and link those procedures back to the relevant environment or deployment. Keep one canonical copy of scripts and connection settings. A topic guide can describe alternative implementations and explain when each applies.
|
|
|
|
## Record Applicability
|
|
Use a short, specific admonition for incomplete instructions, version constraints, or conflicting environment notes. Mark an approach historical or superseded only when the recorded evidence supports that conclusion. A file move or formatting review does not establish that a procedure was executed successfully.
|
|
|
|
## Maintain Filenames and Links
|
|
Use descriptive Title Case filenames and lowercase `index.md` for landing pages. Repair source-relative Markdown links whenever either endpoint moves, including the case of filenames and any changed heading anchors. The [path-change reference](<Documentation Path Changes.md>) records the former locations for maintaining bookmarks or server-side redirects.
|
|
|
|
## Apply the House Style
|
|
Follow [Documentation Styling](<Documentation Styling.md>) for complete Markdown and document-type requirements.
|
|
|
|
## Related Documentation
|
|
- [Related Foundations Documentation](<index.md>) — Find the connected deployments, procedures, and references for this subject.
|