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/migration-guide.template.md
View on GitHub---
author: Joseph OBrien
status: unpublished
updated: '2025-12-23'
version: 1.0.1
tag: skill
type: reference
parent: documentation
---
# Migration Guide: {{FROM_VERSION}} to {{TO_VERSION}}
**Last Updated:** {{DATE}}
**Estimated Effort:** {{LOW|MEDIUM|HIGH}}
**Breaking Changes:** {{YES|NO}}
---
## Overview
{{MIGRATION_SUMMARY}}
### Who Should Migrate
- [ ] All users of {{FEATURE}}
- [ ] Users with custom {{COMPONENT}}
- [ ] Self-hosted deployments
### Prerequisites
- {{PREREQUISITE_1}}
- {{PREREQUISITE_2}}
- Backup your data before proceeding
---
## Breaking Changes
### {{BREAKING_CHANGE_1}}
**Before ({{OLD_VERSION}}):**
```{{LANGUAGE}}
{{OLD_CODE}}
```
**After ({{NEW_VERSION}}):**
```{{LANGUAGE}}
{{NEW_CODE}}
```
**Migration:**
1. {{STEP_1}}
2. {{STEP_2}}
**Automated Fix:**
```bash
{{CODEMOD_OR_SCRIPT}}
```
---
### {{BREAKING_CHANGE_2}}
**What Changed:** {{DESCRIPTION}}
**Impact:** {{WHO_IS_AFFECTED}}
**Action Required:**
- [ ] {{ACTION_1}}
- [ ] {{ACTION_2}}
---
## Deprecations
| Deprecated | Replacement | Removal Version |
|------------|-------------|-----------------|
| `{{OLD_API}}` | `{{NEW_API}}` | {{VERSION}} |
| `{{OLD_CONFIG}}` | `{{NEW_CONFIG}}` | {{VERSION}} |
### Deprecation Warnings
To see all deprecation warnings:
```bash
{{COMMAND_TO_SHOW_WARNINGS}}
```
---
## Step-by-Step Migration
### Step 1: {{STEP_TITLE}}
{{STEP_DESCRIPTION}}
```bash
{{COMMANDS}}
```
**Verification:**
```bash
{{VERIFICATION_COMMAND}}
```
Expected output:
```
{{EXPECTED_OUTPUT}}
```
---
### Step 2: {{STEP_TITLE}}
{{STEP_DESCRIPTION}}
**Before:**
```{{LANGUAGE}}
{{OLD_CODE}}
```
**After:**
```{{LANGUAGE}}
{{NEW_CODE}}
```
---
### Step 3: {{STEP_TITLE}}
{{STEP_DESCRIPTION}}
| Old | New |
|-----|-----|
| `{{OLD}}` | `{{NEW}}` |
---
## Configuration Changes
### Environment Variables
| Old Variable | New Variable | Default |
|--------------|--------------|---------|
| `{{OLD_VAR}}` | `{{NEW_VAR}}` | `{{DEFAULT}}` |
### Config File Changes
**Before (`{{CONFIG_FILE}}`):**
```{{FORMAT}}
{{OLD_CONFIG}}
```
**After (`{{CONFIG_FILE}}`):**
```{{FORMAT}}
{{NEW_CONFIG}}
```
---
## Database Migrations
### Required Migrations
```bash
{{MIGRATION_COMMAND}}
```
### Schema Changes
| Table | Change | SQL |
|-------|--------|-----|
| `{{TABLE}}` | {{ADD/MODIFY/DROP}} | `{{SQL}}` |
### Data Migration
```sql
{{DATA_MIGRATION_SQL}}
```
**Rollback:**
```sql
{{ROLLBACK_SQL}}
```
---
## Dependency Updates
| Package | Old Version | New Version | Notes |
|---------|-------------|-------------|-------|
| `{{PKG}}` | `{{OLD}}` | `{{NEW}}` | {{NOTES}} |
```bash
{{UPDATE_COMMAND}}
```
---
## API Changes
### Endpoint Changes
| Old Endpoint | New Endpoint | Method |
|--------------|--------------|--------|
| `{{OLD_PATH}}` | `{{NEW_PATH}}` | {{METHOD}} |
### Request/Response Changes
**Before:**
```json
{{OLD_JSON}}
```
**After:**
```json
{{NEW_JSON}}
```
---
## Troubleshooting
### Common Issues
#### {{ISSUE_1}}
**Symptom:** {{SYMPTOM}}
**Cause:** {{CAUSE}}
**Solution:**
```bash
{{SOLUTION}}
```
---
#### {{ISSUE_2}}
**Symptom:** {{SYMPTOM}}
**Solution:** {{SOLUTION}}
---
## Rollback Procedure
If migration fails:
1. {{ROLLBACK_STEP_1}}
2. {{ROLLBACK_STEP_2}}
3. {{ROLLBACK_STEP_3}}
```bash
{{ROLLBACK_COMMANDS}}
```
---
## Verification Checklist
- [ ] All tests pass
- [ ] No deprecation warnings
- [ ] Application starts successfully
- [ ] Core functionality works
- [ ] Performance acceptable
- [ ] Logs show no errors
### Smoke Tests
```bash
{{SMOKE_TEST_COMMANDS}}
```
---
## Support
- Documentation: {{DOCS_URL}}
- Issues: {{ISSUES_URL}}
- Community: {{COMMUNITY_URL}}
---
## Quality Checklist
- [ ] All breaking changes documented
- [ ] Code examples show before/after
- [ ] Automated migration scripts provided where possible
- [ ] Rollback procedure documented
- [ ] Verification steps included
- [ ] Troubleshooting covers common issues
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 |