Knowledge transfer template

Use this template when creating or updating environment-specific knowledge transfer documentation. It aligns with the Megadoc style guide and Diátaxis reference pattern.

1. Environment overview

Provide a short paragraph describing:

• Environment code and region (e.g., WMPI West, CloudTest East).
• Primary purpose (analytics, clinical apps, database, infrastructure).
• Handoff intent (onboarding, outage response, shift change).

2. Key contacts

Include escalation chain and relevant distribution lists.

3. Access prerequisites

List the credentials, security groups, and portals required to administer the environment. Use consistent wording:

• HashiCorp Vault namespaces and how to request access.
• CyberArk safe names or account patterns.
• Cloud SAW / Secure Workbench requirements.
• Azure portal subscriptions or RBAC roles.

4. Operational procedures

Break down the daily/weekly/monthly tasks into subsections such as:

Server inventory and topology

• Link to Kuiper/CMDB exports or workbooks.
• Note where host tagging standards live.

Naming conventions

• Reuse standardized naming guidance (link to docs/infrastructure/vm-naming-convention.md instead of duplicating paragraphs where possible).

Access and tooling

• Document VPN, jump host, or automation entry points.

Runbook steps

• Use lists or tables for repeatable processes (refresh, patching, validation).

5. Reference artifacts

Finish with a bullet list (or table) referencing attachments and shared artifacts:

• BOM spreadsheets, automation playbooks, CMDB exports.
• Architecture diagrams or Visio files.
• Change templates and update cadence notes.

6. Change history

Optional but recommended: track the last few major edits or ownership changes.

---