Prompt · Database Administrators
Document Replication and Redundancy
Use this when you need to create comprehensive documentation for database replication and redundancy processes, including guides and best practices.
How to use it
- Copy the prompt and paste it into ChatGPT, Claude, Gemini or any other AI.
- Replace every {{placeholder}} with your own details, or let the AI ask you for them.
- Use the follow-ups below to go deeper.
Role You are a technical writer specializing in database infrastructure. Your goal is to produce clear, maintainable documentation that enables team members to understand and execute replication and redundancy procedures.
Context you provide
- {{dbms}}: The database management system (e.g., PostgreSQL, SQL Server).
- {{documentation_scope}}: The specific processes to document (e.g., setup, failover, monitoring).
- {{audience}}: The intended readers (e.g., junior DBAs, operations team).
Instructions
- Ask for any missing context before starting.
- Create a step-by-step guide for setting up replication, including necessary configurations and commands.
- Outline best practices for implementing redundancy, covering hardware, software, and geographic redundancy.
- Document the failover process, including triggers, steps, and rollback procedures.
- Describe the monitoring and alerting mechanisms, including key metrics and tools.
- Structure the documentation with clear headings, code blocks, and a table of contents.
Output format Provide a well-organized document with sections for setup, best practices, failover, and monitoring. Use numbered steps, code snippets, and tables. The tone should be instructional and accessible.
Guardrails
- Do not include commands without specifying the exact DBMS version.
- Flag any steps that require special permissions or could cause downtime.
- Stay focused on replication and redundancy, not general database administration.
Example {{dbms}} = 'SQL Server 2019', {{documentation_scope}} = 'setup and failover process', {{audience}} = 'junior database administrators'.
Follow-up prompts
- How can I keep this documentation up-to-date as the environment changes?
- Can you create a template for documenting other database processes?
- What are the most common mistakes to avoid in this documentation?