aiskillstore/marketplace / skills/89jobrien/documentation
documentation
VerifiedComprehensive documentation specialist covering API documentation, technical writing, design documentation, migration guides, and changelog generation. Use when creating OpenAPI/Swagger specs, generating SDKs, writing user guides, creating README files, documenting architecture, writing design specs, creating ADRs, writing migration guides, or generating changelogs from git commits. Handles versioning, examples, developer experience, and user-facing documentation.
| File | Kind | Size |
|---|---|---|
| SKILL.md | skill md | 10.7 KB |
| references/CHANGELOG.template.md | markdown | 2.9 KB |
| references/api-docs.md | markdown | 7.3 KB |
| references/api-documentation.template.md | markdown | 4.8 KB |
| references/architecture-decision-record.template.md | markdown | 2.2 KB |
| references/changelogs.md | markdown | 7.5 KB |
| references/design-spec.template.md | markdown | 4.2 KB |
| references/migration-guide.template.md | markdown | 3.9 KB |
| references/technical-writing.md | markdown | 7.6 KB |
| skill-report.json | config | 69.2 KB |
references/design-spec.template.md
View on GitHub---
author: Joseph OBrien
status: unpublished
updated: '2025-12-23'
version: 1.0.1
tag: skill
type: reference
parent: documentation
---
# Design Specification: {{FEATURE_NAME}}
**Author:** {{NAME}}
**Date:** {{YYYY-MM-DD}}
**Status:** {{DRAFT|REVIEW|APPROVED|IMPLEMENTED}}
**Reviewers:** {{NAMES}}
---
## Overview
### Problem Statement
{{WHAT_PROBLEM_ARE_WE_SOLVING}}
### Goals
- {{GOAL_1}}
- {{GOAL_2}}
- {{GOAL_3}}
### Non-Goals
- {{NON_GOAL_1}}
- {{NON_GOAL_2}}
---
## Background
### Context
{{RELEVANT_BACKGROUND_INFO}}
### Current State
{{HOW_THINGS_WORK_TODAY}}
### User Research / Requirements
| Requirement | Source | Priority |
|-------------|--------|----------|
| {{REQ_1}} | {{SOURCE}} | {{P0-P3}} |
| {{REQ_2}} | {{SOURCE}} | {{P0-P3}} |
---
## Proposed Solution
### High-Level Design
{{SOLUTION_OVERVIEW}}
```
{{ARCHITECTURE_DIAGRAM}}
```
### User Flow
1. User {{ACTION_1}}
2. System {{RESPONSE_1}}
3. User {{ACTION_2}}
4. System {{RESPONSE_2}}
### Data Model
```{{LANGUAGE}}
{{DATA_STRUCTURES}}
```
### API Design
#### {{ENDPOINT_NAME}}
```
{{METHOD}} {{PATH}}
```
**Request:**
```json
{{REQUEST_BODY}}
```
**Response:**
```json
{{RESPONSE_BODY}}
```
---
## Detailed Design
### Component 1: {{COMPONENT_NAME}}
**Purpose:** {{PURPOSE}}
**Implementation:**
```{{LANGUAGE}}
{{CODE_SAMPLE}}
```
**Interactions:**
- Receives: {{INPUT}}
- Produces: {{OUTPUT}}
- Depends on: {{DEPENDENCIES}}
---
### Component 2: {{COMPONENT_NAME}}
**Purpose:** {{PURPOSE}}
**Implementation:**
{{DESCRIPTION}}
---
### State Management
| State | Type | Initial | Transitions |
|-------|------|---------|-------------|
| {{STATE}} | {{TYPE}} | {{VALUE}} | {{TRANSITIONS}} |
### Error Handling
| Error Case | Handling | User Message |
|------------|----------|--------------|
| {{ERROR}} | {{HANDLING}} | {{MESSAGE}} |
---
## Alternatives Considered
### Alternative 1: {{NAME}}
{{DESCRIPTION}}
**Pros:**
- {{PRO}}
**Cons:**
- {{CON}}
**Why Not:** {{REASON}}
---
### Alternative 2: {{NAME}}
{{DESCRIPTION}}
**Why Not:** {{REASON}}
---
## Security Considerations
### Threats
| Threat | Risk | Mitigation |
|--------|------|------------|
| {{THREAT}} | {{H/M/L}} | {{MITIGATION}} |
### Data Privacy
- {{PRIVACY_CONSIDERATION_1}}
- {{PRIVACY_CONSIDERATION_2}}
---
## Performance Considerations
### Expected Load
| Metric | Expected | Peak |
|--------|----------|------|
| Requests/sec | {{N}} | {{N}} |
| Response Time | {{MS}}ms | {{MS}}ms |
### Scalability
{{HOW_SOLUTION_SCALES}}
### Caching Strategy
{{CACHING_APPROACH}}
---
## Testing Strategy
### Unit Tests
- {{TEST_CASE_1}}
- {{TEST_CASE_2}}
### Integration Tests
- {{TEST_CASE_1}}
- {{TEST_CASE_2}}
### Edge Cases
- {{EDGE_CASE_1}}
- {{EDGE_CASE_2}}
---
## Rollout Plan
### Phase 1: {{PHASE_NAME}}
- {{DELIVERABLE}}
- Audience: {{WHO}}
### Phase 2: {{PHASE_NAME}}
- {{DELIVERABLE}}
- Audience: {{WHO}}
### Feature Flags
| Flag | Purpose | Default |
|------|---------|---------|
| `{{FLAG}}` | {{PURPOSE}} | {{VALUE}} |
### Rollback Criteria
- {{ROLLBACK_TRIGGER_1}}
- {{ROLLBACK_TRIGGER_2}}
---
## Monitoring & Observability
### Metrics
| Metric | Purpose | Alert Threshold |
|--------|---------|-----------------|
| {{METRIC}} | {{PURPOSE}} | {{THRESHOLD}} |
### Logging
| Event | Level | Data |
|-------|-------|------|
| {{EVENT}} | {{INFO/WARN/ERROR}} | {{DATA}} |
### Dashboards
- {{DASHBOARD_1}}
- {{DASHBOARD_2}}
---
## Dependencies
### External Dependencies
| Dependency | Purpose | Owner |
|------------|---------|-------|
| {{DEP}} | {{PURPOSE}} | {{OWNER}} |
### Internal Dependencies
- {{INTERNAL_DEP_1}}
- {{INTERNAL_DEP_2}}
---
## Open Questions
1. {{QUESTION_1}}
2. {{QUESTION_2}}
---
## Timeline
| Milestone | Date |
|-----------|------|
| Design Review | {{DATE}} |
| Implementation Start | {{DATE}} |
| Testing Complete | {{DATE}} |
| Rollout | {{DATE}} |
---
## References
- [{{DOC_1}}]({{URL}})
- [{{DOC_2}}]({{URL}})
---
## Quality Checklist
- [ ] Problem clearly stated
- [ ] Goals and non-goals defined
- [ ] Alternatives considered
- [ ] Security reviewed
- [ ] Performance considered
- [ ] Testing strategy defined
- [ ] Rollout plan documented
- [ ] Monitoring planned
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| brainstormingobra/superpowersYou MUST use this before any creative work - creating features, building components, adding functionality, modifying behavior, or planning anything new, in software or out of it (a talk, a business, a renovation). | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |
| brand-guidelinesanthropics/skillsApplies Anthropic's official brand colors and typography to any sort of artifact that may benefit from having Anthropic's look-and-feel. Use it when brand colors or style guidelines, visual formatting, or company design standards apply. | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |
| frontend-designanthropics/skillsGuidance for distinctive, intentional visual design when building new UI or reshaping an existing one. Helps with aesthetic direction, typography, and making choices that don't read as templated defaults. | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |
| mcp-builderanthropics/skillsGuide for creating high-quality MCP (Model Context Protocol) servers that enable LLMs to interact with external services through well-designed tools. Use when building MCP servers to integrate external APIs or services, whether in Python (FastMCP) or Node/TypeScript (MCP SDK). | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |