From e3ee94cbf66b89e127c8b70f05376bd7b39156de Mon Sep 17 00:00:00 2001 From: Administrator Date: Tue, 3 Feb 2026 02:57:19 +0000 Subject: [PATCH] docs: create Service_Document_Template --- Service_Document_Template.md | 122 +++++++++++++++++++++++++++++++++++ 1 file changed, 122 insertions(+) create mode 100644 Service_Document_Template.md diff --git a/Service_Document_Template.md b/Service_Document_Template.md new file mode 100644 index 0000000..ce60e38 --- /dev/null +++ b/Service_Document_Template.md @@ -0,0 +1,122 @@ +--- +title: Service Documentation Template +description: Describe the service +published: true +date: 2026-02-03T02:57:07.462Z +tags: +editor: markdown +dateCreated: 2026-02-03T02:57:07.462Z +--- + +# Service Documentation Template + +Use this template for **every new service** documented under `services/`. + +Copy this file, rename it, and fill in all sections. + +--- + +# Service Name + +## Overview + +Brief description of what this service does and why it exists. + +--- + +## Architecture + +Describe how the service is deployed. + +Include: +- Host(s) +- Containers +- External dependencies +- Network exposure + +--- + +## Volumes & Data + +List all persistent data locations. +``` +/path/on/host → purpose +``` + +Include: +- What data is stored +- Whether it is critical +- Where backups occur + +--- + +## Configuration + +Document: +- Environment variables (non-secret) +- Configuration files +- Important defaults + +**Secrets must not be stored here.** Reference where they live instead. + +--- + +## Authentication & Access + +Describe: +- Authentication method +- Local access +- Break-glass access (if applicable) + +--- + +## Backups + +Explain: +- What is backed up +- How often +- Using what tool +- Where backups are stored + +Link to infrastructure backup docs if applicable. + +--- + +## Restore Procedure + +Step-by-step recovery instructions. +```bash +# example commands +``` + +This section must be usable when the service is broken. + +--- + +## Monitoring & Health + +Describe: +- How service health is checked +- Logs of interest +- Alerting (if any) + +--- + +## Common Failures + +List known failure modes and fixes. + +--- + +## Diagrams + +Embed architecture diagrams here. +```markdown +![Service Architecture](../diagrams//.png) +``` + +--- + +## Notes + +Anything that does not fit elsewhere. \ No newline at end of file