Confluence Documentation Patterns

Included with Lifetime

$97 forever

This skill should be used when the user asks to "create a Confluence page", "write documentation", "write a TDD", "create an ADR", "write a runbook", or "publish to Confluence" — authoring and linking technical documentation in Confluence from Jira work.

General

What this skill does


# Confluence Documentation Patterns

Create, manage, and organize technical documentation in Confluence with Jira integration.

## When to Use This Skill

- Creating technical design documents (TDD)
- Writing API documentation
- Documenting architecture decisions (ADR)
- Creating runbooks and playbooks
- Writing release notes and meeting notes
- Linking documentation to Jira issues
- Searching documentation

## Document Templates Overview

### TDD - Technical Design Document
- **When:** New features, architecture changes, complex implementations
- **Key Sections:** Executive Summary, Problem Statement, Solution, Implementation Details, Testing Strategy
- **Metadata:** Status, Author, Jira Issue link, Reviewers

### ADR - Architecture Decision Record
- **When:** Technology choices, architectural patterns, design tradeoffs
- **Key Sections:** Context, Decision, Consequences, Alternatives Considered
- **Metadata:** Status (Proposed|Accepted|Deprecated|Superseded), Date, Decision Makers

### API Documentation
- **Key Sections:** Overview, Authentication, Base URL, Endpoints, Error Handling, Examples
- **Metadata:** Version, Authentication method, Last Updated

### Runbook / Playbook
- **When:** Operational procedures, incident response
- **Key Sections:** Quick Reference, Emergency Contacts, Common Procedures, Escalation Path
- **Metadata:** Service name, Team, On-Call channel

### Release Notes
- **Key Sections:** Summary, Highlights, New Features, Bug Fixes, Breaking Changes
- **Metadata:** Release Date, Release Manager, Related Jira Release

### Meeting Notes
- **Key Sections:** Attendees, Agenda, Discussion, Action Items, Decisions
- **Metadata:** Date, Time, Location, Facilitator

### Sprint Retrospective
- **Key Sections:** Sprint Summary, What Went Well, Improvements, Action Items
- **Metadata:** Sprint number, Team, Facilitator

## Confluence Query Language (CQL)

**Basic Syntax:** `field operator value`

**Common Fields:**
- `title`, `text`, `label`, `space`, `type`, `creator`, `lastModified`, `ancestor`

**Operators:** `=`, `!=`, `~` (contains), `>`, `<`, `>=`, `<=`, `IN`, `AND`, `OR`, `NOT`

**Essential Patterns:**
```cql
label = "tdd" AND space = "ENG" ORDER BY lastModified DESC
lastModified >= now("-1w") AND space = "ENG"
title ~ "API" AND label = "authentication"
label = "adr" AND text ~ "Status: Approved"
label = "runbook" AND label = "production" AND space = "OPS"
label = "draft" AND creator = currentUser()
```

## Jira-Confluence Integration

**Linking Documentation to Issues:**
- Smart Links: `[TDD - Feature](confluence-url)` in Jira/Confluence descriptions
- Jira Macro: `{jira:PROJ-123}` displays issue card with status, assignee, summary

**Embedding Jira Data:**
- Single issue: `{jira:PROJ-123|columns=key,summary,status,assignee}`
- JQL query: `{jira:jql=project=PROJ AND status="In Progress"|columns=key,summary}`
- Issue count: `{jiraissues:project=PROJ AND type=Bug|count}`
- Timeline: `{jira-chart:type=timeline|project=PROJ}`

**Best Practices:**
- Link all documentation in Jira issue descriptions or comments
- Use labels consistently (tdd, adr, runbook, api-docs, release-notes)
- Name spaces by team/domain (ENG, OPS, PRODUCT)
- Archive documentation when superseded or deprecated

Files: 1

Size: 3.8 KB

Complexity: 13/100

Category: General

Source: https://github.com/lobbi-docs/claude/tree/main/plugins/jira-orchestrator/skills/confluence

Related in General

modeling-omnistudio-epc-catalog

Included

Salesforce Industries CME EPC product-modeling skill for Product2-based catalog creation. Use when creating EPC products, configuring product attributes, building offer bundles with Product Child Items, or reviewing EPC DataPack JSON metadata for product catalog changes. TRIGGER when: user creates or updates Product2 EPC records, AttributeAssignment payloads, AttributeMetadata/AttributeDefaultValues, Offer bundles, or ProductChildItem relationships. DO NOT TRIGGER when: designing OmniScripts/FlexCards/Integration Procedures (use building-omnistudio-omniscript, building-omnistudio-flexcard, or building-omnistudio-integration-procedure), implementing Apex business logic (use generating-apex), or troubleshooting deployment pipelines (use deploying-metadata).

Generalscripts

relationship-science-coach

Included

Use this skill for direct, practical adult relationship coaching: couples conflict, repair, trust, marriage, dating, flirting, attachment patterns, emotional connection, sex, desire differences, eroticism, kink negotiation, affection, love languages, breakups, and long-term passion. Draw on Gottman, EFT and Hold Me Tight, attachment science, modern sex research, Perel, Nagoski, Kerner, Schnarch, Love and Stosny, and flexible love-language tools. Be concrete and low-hedge. Redirect only for imminent danger, abuse, coercive control, minors, non-consent, self-harm, stalking, or medical/legal/psychiatric decisions.

Generalscripts

building-sf-integrations

Included

Salesforce integration architecture and runtime plumbing with 120-point scoring. Use this skill to set up Named Credentials, External Credentials, External Services, REST/SOAP callout patterns, Platform Events, and Change Data Capture. TRIGGER when: user sets up Named Credentials, External Services, REST/SOAP callouts, Platform Events, CDC, or touches .namedCredential-meta.xml files. DO NOT TRIGGER when: Connected App/OAuth config (use configuring-connected-apps), Apex-only logic (use generating-apex), or data import/export (use handling-sf-data).

Generalscripts

venue-templates

Included

Access comprehensive LaTeX templates, formatting requirements, and submission guidelines for major scientific publication venues (Nature, Science, PLOS, IEEE, ACM), academic conferences (NeurIPS, ICML, CVPR, CHI), research posters, and grant proposals (NSF, NIH, DOE, DARPA). This skill should be used when preparing manuscripts for journal submission, conference papers, research posters, or grant proposals and need venue-specific formatting requirements and templates.

Generalscripts

let-fate-decide

Included

Draws the 12 Houses of the Zodiac Tarot spread to inject entropy into planning when prompts are vague, ambiguous, or casually delegated. Interprets the spread to guide next steps. Use when the user says 'let fate decide', 'YOLO', 'whatever', 'idk', or other nonchalant phrases, makes Yu-Gi-Oh references, or when you are about to arbitrarily pick between multiple reasonable approaches. Prefer over ask-questions-if-underspecified when the user's tone is casual or playful rather than precision-seeking.

Generalscripts

net-ops

Included

Cross-platform network troubleshooting (Windows, macOS, Linux) via local or remote shell. Use for: DNS broken, can't resolve hostnames, nslookup/dig works but apps fail, NRPT, WFP, scutil, /etc/resolver, systemd-resolved, /etc/resolv.conf, NetworkManager, VPN DNS leak residue (ProtonVPN/Mullvad/WireGuard/AnyConnect), AV/firewall blocking DNS or DoH, Tailscale DNS interaction, intermittent connectivity, remote diagnostics over SSH.

Generalscripts