Skill: Confluence Technical Documentation

Skill: Confluence Technical Documentation

Purpose

Create and maintain technical documentation including technical specifications, API documentation, system architecture docs, and developer guides.

When to Use

• Software Architect creates technical specification
• Software Architect documents system architecture
• Senior Developer documents APIs
• Senior Developer creates implementation guides

MCP Tools Used

Tool	Purpose
Atlassian:createConfluencePage	Create new documentation
Atlassian:updateConfluencePage	Update existing docs
Atlassian:getConfluencePage	Read current content
Atlassian:searchConfluenceUsingCql	Find existing docs

Configuration

{
  "cloudId": "{{confluence.cloudId}}",
  "spaceId": "{{confluence.spaceId}}",
  "spaceKey": "{{confluence.spaceKey}}",
  "parentPages": {
    "technical": "{{confluence.parentPages.technical}}"
  }
}

---

Technical Specification

Tech Spec Template

# Technical Specification: {{featureName}}

**Version:** 1.0
**Author:** Software Architect Agent
**Created:** {{date}}
**Status:** Draft | In Review | Approved
**Related:** BRD-{{number}} | EPIC-{{number}}

---

## Overview

### Purpose
[What this specification covers]

### Scope
[What is included/excluded]

### Related Documents
- BRD: [Link]
- ADR: [Link]

---

## Architecture

### System Context
[How this fits in the overall system]

### Component Diagram

┌─────────────┐ ┌─────────────┐ │ Client │────►│ API │ └─────────────┘ └──────┬──────┘ │ ┌──────▼──────┐ │ Service │ └──────┬──────┘ │ ┌──────▼──────┐ │ Database │ └─────────────┘

### Data Flow
1. [Step 1]
2. [Step 2]
3. [Step 3]

---

## Technical Design

### Data Model

#### Entity: {{EntityName}}
| Field | Type | Constraints | Description |
|-------|------|-------------|-------------|
| id | UUID | PK | Unique identifier |
| name | string | NOT NULL | |
| created_at | timestamp | NOT NULL | |

### API Design

#### Endpoint: {{method}} {{path}}

**Request:**
```json
{
  "field": "value"
}

Response (200):

{
  "id": "uuid",
  "field": "value"
}

Error Responses:

Code	Description
400	Invalid request
401	Unauthorized
404	Not found

---

Implementation Details

Technology Stack

Component	Technology	Rationale
Backend
Database
Cache

Dependencies

Configuration

Setting	Default	Description

---

Security Considerations

• [Security measure 1]
• [Security measure 2]

Performance Requirements

Metric	Target	Measurement
Response time	<200ms	P95
Throughput	1000 RPS

---

Testing Strategy

Unit Tests

• [Test area 1]

Integration Tests

• [Test area 2]

Performance Tests

• [Test area 3]

---

Deployment

Prerequisites

• [Prerequisite 1]

Steps

1. [Step 1]
2. [Step 2]

Rollback

1. [Rollback step 1]

---

Open Questions

• [Question 1]
• [Question 2]

### Create Tech Spec Example
```javascript
Atlassian:createConfluencePage({
  cloudId: "{{confluence.cloudId}}",
  spaceId: "{{confluence.spaceId}}",
  parentId: "{{confluence.parentPages.technical}}",
  title: "Tech Spec: User Authentication",
  body: `# Technical Specification: User Authentication

**Version:** 1.0
**Author:** Software Architect Agent
**Created:** 2025-01-06
**Status:** Draft
**Related:** BRD-001 | MDDEV-100

---

## Overview

### Purpose
Define the technical implementation for user authentication including registration, login, and session management.

### Scope
- User registration and validation
- Password hashing and storage
- JWT-based authentication
- Session management

---

## Architecture

### Component Diagram
\`\`\`
┌─────────────┐     ┌─────────────┐
│   Client    │────►│  Auth API   │
└─────────────┘     └──────┬──────┘
                           │
                    ┌──────▼──────┐
                    │ Auth Service│
                    └──────┬──────┘
                           │
                    ┌──────▼──────┐
                    │  User DB    │
                    └─────────────┘
\`\`\`

---

## Technical Design

### Data Model

#### Entity: User
| Field | Type | Constraints | Description |
|-------|------|-------------|-------------|
| id | UUID | PK | Unique identifier |
| email | string | UNIQUE, NOT NULL | User email |
| password_hash | string | NOT NULL | Bcrypt hash |
| created_at | timestamp | NOT NULL | Registration date |

### API Design

#### POST /auth/register

**Request:**
\`\`\`json
{
  "email": "user@example.com",
  "password": "securePassword123"
}
\`\`\`

**Response (201):**
\`\`\`json
{
  "id": "uuid",
  "email": "user@example.com"
}
\`\`\`

---

## Security Considerations

- Passwords hashed with bcrypt (cost factor 12)
- JWT tokens expire after 24 hours
- Rate limiting on auth endpoints
- HTTPS required
`,
  contentFormat: "markdown"
})

---

API Documentation

API Doc Template

# API Documentation: {{serviceName}}

**Base URL:** `{{baseUrl}}`
**Version:** v1
**Last Updated:** {{date}}

---

## Authentication

All endpoints require Bearer token:

Authorization: Bearer

---

## Endpoints

### {{Resource}}

#### List {{Resources}}
`GET /{{resources}}`

**Query Parameters:**
| Param | Type | Required | Description |
|-------|------|----------|-------------|
| page | int | No | Page number |
| limit | int | No | Items per page |

**Response:**
```json
{
  "data": [...],
  "pagination": {
    "page": 1,
    "total": 100
  }
}

Get {{Resource}}

GET /{{resources}}/:id

Create {{Resource}}

POST /{{resources}}

Update {{Resource}}

PUT /{{resources}}/:id

Delete {{Resource}}

DELETE /{{resources}}/:id

---

Error Codes

Code	Message	Description
400	Bad Request	Invalid input
401	Unauthorized	Missing/invalid token
403	Forbidden	Insufficient permissions
404	Not Found	Resource not found
500	Server Error	Internal error

---

## Error Handling

| Error | Cause | Resolution |
|-------|-------|------------|
| 400 Bad Request | Invalid markdown/code blocks | Escape special characters |
| 404 Not Found | Parent page missing | Create parent first |
| 413 Too Large | Document too big | Split into multiple pages |