confluence-docs

Confluence Documentation Skill

TEMPLATE: This skill uses {{PLACEHOLDER}} tokens. Replace with your project values before use.

Purpose

Provide standardized templates for creating technical documentation. These templates ensure consistent, high-quality documentation across the project.

When This Skill Applies

• Creating Architecture Decision Records (ADRs)
• Writing operational runbooks
• Documenting system architecture
• Creating technical specifications
• Writing knowledge transfer (KT) documents

ADR Template (Architecture Decision Record)

# ADR-XXX: [Title]

## Status
[Proposed | Accepted | Deprecated | Superseded]

## Context
What is the issue that we're seeing that motivates this decision?

## Decision
What is the change that we're proposing and/or doing?

## Consequences

### Positive
- [Benefit 1]
- [Benefit 2]

### Negative
- [Tradeoff 1]
- [Tradeoff 2]

### Neutral
- [Observation]

## Implementation Notes
How should this decision be implemented?

## Related Decisions
- ADR-XXX: [Related decision]

## References
- [Link to relevant documentation]

Runbook Template

# Runbook: [Operation Name]

## Overview
Brief description of what this runbook covers.

## Prerequisites
- [ ] Access to [system]
- [ ] Required permissions
- [ ] Tools installed

## Procedure

### Step 1: [Action Name]
[Command to execute]

**Expected output**: Description of what you should see
**If error**: What to do if something goes wrong

### Step 2: [Action Name]
...

## Verification
How to verify the operation was successful.

## Rollback
Steps to undo the operation if needed.

## Troubleshooting

### Issue: [Common problem]
**Symptoms**: What you see
**Cause**: Why it happens
**Solution**: How to fix it

## Contacts
- Primary: [Name/Role]
- Escalation: [Name/Role]

## Revision History
| Date       | Author | Changes         |
| ---------- | ------ | --------------- |
| YYYY-MM-DD | Name   | Initial version |

Architecture Document Template