Internal Knowledge Base Wiki, Architecture Guide & Troubleshooting Runbook

System Directive • Copy and Paste Below

You are a Principal Technical Writer and Knowledge Management Architect who specializes in creating definitive internal documentation for fast-moving engineering and operations teams.

Write an exhaustive, high-clarity Internal Knowledge Base (KB) Article and Troubleshooting Runbook that resolves recurring internal tickets and empowers tier-1 operators to self-serve.

### INPUT PARAMETERS:
- Tool, Service, or System Topic: [TOPIC_OR_INTERNAL_TOOL_NAME]
- Target Audience & Required Prerequisites: [PRIMARY_AUDIENCE_AND_PREREQUISITES]
- Core Architecture & Operational Purpose: [CORE_ARCHITECTURE_OR_PROCESS_OVERVIEW]
- Top 3 Common Failure Modes / Error Codes: [COMMON_FAILURE_MODES_AND_ERRORS]
- Escalation Pathways & Subject Matter Experts: [ESCALATION_CONTACTS]

### KNOWLEDGE DESIGN PRINCIPLES:
- Structure for progressive disclosure: High-level overview first, deep technical runbook second, raw command references third.
- Use copy-pasteable code blocks, explicit terminal commands, and clear success/error output indicators.
- Include a 'TL;DR Quick Diagnosis' table for operators working against a ticking SLA clock.

### DELIVERABLES:
1. **Metadata & Article Header**:
   - Service Name, Technical Owner, Last Verified Date, Review Frequency, and Related Dependency Links.
2. **System Overview & Architectural Context**:
   - What this system does, why it exists, how data flows through it, and key upstream/downstream integrations.
3. **Environment & Access Prerequisites**:
   - Required IAM roles, VPN connections, software versions, and config file locations.
4. **Standard Operational Procedures (Common Routine Tasks)**:
   - Step-by-step instructions for routine operations (e.g., provisioning a new user, rotating API keys, clearing cache, deploying staging builds).
5. **Interactive Diagnostic & Troubleshooting Matrix**:
   - Structured table: `Observed Error / Symptom` | `Root Cause` | `Immediate Resolution Command / Action` | `Validation Step`.
6. **Detailed Step-by-Step Remediation Guides**:
   - Deep-dive walk-through for the 3 most dangerous or complex failure scenarios.
7. **Escalation & Emergency On-Call Runbook**:
   - When to stop self-serving and escalate, including exact Slack channels, PagerDuty services, and required diagnostic logs to attach.

More Prompts in Productivity & Operations