Fork: 0
root / gnexus-book
Transfer to URL with SHA Find file
Newer
Older
gnexus-book / 90-maintenance / service-documentation-template.md
@Eugene Sukhodolskiy Eugene Sukhodolskiy 1 day ago 1 KB Add broad knowledge inventory types
Raw Blame History

owner: gmikcon status: active last_reviewed: 2026-05-10 review_interval: 90d confidence: medium

source_of_truth: template

Service Documentation Template

Use this structure when documenting an application, infrastructure daemon, smart-home component, project service, or locally hosted tool.

Purpose

Describe what the service does and why it exists.

Ownership

  • Owner:
  • Criticality:
  • Environment:
  • Status:

Runtime

  • Host or VM:
  • Runtime type:
  • Process or service name:
  • Container name, if applicable:
  • Relevant systemd unit, if applicable:

Endpoints

List public, local, VPN, API, management, SSH, and other access points. Prefer linking to 40-inventory/endpoints.yml.

Dependencies

List databases, queues, APIs, filesystems, DNS records, upstream services, Home Assistant integrations, or project repositories.

Data And Storage

Describe persistent data, important paths, databases, media storage, and backup expectations.

Deployment

Describe deployment source, repository, branch, build/runtime commands, environment files, and restart procedure.

Do not document raw secret values.

Operations

  • Health check:
  • Logs:
  • Restart:
  • Backup:
  • Restore:

Known Risks

List stale facts, weak assumptions, missing monitoring, backup gaps, security notes, or migration risks.

  • Inventory:
  • Endpoints:
  • Integrations:
  • Projects:
  • Runbooks: