Skip to content

aiskillstore/marketplace / skills/89jobrien/documentation

documentation

Verified

Comprehensive 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.

references/CHANGELOG.template.md

View on GitHub
---
author: Joseph OBrien
status: unpublished
updated: '2025-12-23'
version: 1.0.1
tag: skill
type: reference
parent: documentation
---

# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

---

## [Unreleased]

### Added

- {{NEW_FEATURE_DESCRIPTION}}

### Changed

- {{CHANGED_BEHAVIOR_DESCRIPTION}}

### Deprecated

- {{DEPRECATED_FEATURE_DESCRIPTION}}

### Removed

- {{REMOVED_FEATURE_DESCRIPTION}}

### Fixed

- {{BUG_FIX_DESCRIPTION}}

### Security

- {{SECURITY_FIX_DESCRIPTION}}

---

## [{{VERSION}}] - {{YYYY-MM-DD}}

### Added

- New feature X that enables users to {{BENEFIT}} ([#{{ISSUE}}]({{ISSUE_URL}}))
- Support for {{NEW_CAPABILITY}}

### Changed

- Improved performance of {{COMPONENT}} by {{PERCENTAGE}}%
- Updated {{DEPENDENCY}} from {{OLD_VERSION}} to {{NEW_VERSION}}

### Deprecated

- `{{OLD_API}}` is deprecated, use `{{NEW_API}}` instead

### Removed

- Removed deprecated `{{FEATURE}}` (deprecated in {{VERSION}})

### Fixed

- Fixed issue where {{BUG_DESCRIPTION}} ([#{{ISSUE}}]({{ISSUE_URL}}))
- Resolved crash when {{SCENARIO}}

### Security

- Fixed {{CVE_ID}}: {{VULNERABILITY_DESCRIPTION}}

---

## [{{VERSION}}] - {{YYYY-MM-DD}}

### Added

- {{FEATURE_1}}
- {{FEATURE_2}}

### Changed

- {{CHANGE_1}}

### Fixed

- {{FIX_1}}
- {{FIX_2}}

---

## Entry Guidelines

### Types of Changes

| Type | Description | Example |
|------|-------------|---------|
| **Added** | New features | "Added dark mode support" |
| **Changed** | Changes in existing functionality | "Changed API response format" |
| **Deprecated** | Soon-to-be removed features | "Deprecated v1 API endpoints" |
| **Removed** | Removed features | "Removed legacy auth system" |
| **Fixed** | Bug fixes | "Fixed login redirect loop" |
| **Security** | Vulnerability fixes | "Fixed XSS vulnerability in forms" |

### Writing Good Entries

**Do:**

- Start with a verb (Added, Changed, Fixed)
- Include issue/PR references
- Explain user impact
- Group related changes

**Don't:**

- Include internal refactoring
- Use technical jargon without explanation
- Leave entries vague

### Examples

```markdown
### Added

- Added export to CSV functionality for reports ([#123](url))
- Added keyboard shortcuts for common actions (Ctrl+S to save)

### Fixed

- Fixed memory leak when processing large files ([#456](url))
- Fixed incorrect timezone display for international users
```

---

## Version Links

[Unreleased]: {{REPO_URL}}/compare/v{{LATEST}}...HEAD
[{{VERSION}}]: {{REPO_URL}}/compare/v{{PREVIOUS}}...v{{VERSION}}

---

## Quality Checklist

- [ ] All user-facing changes documented
- [ ] Breaking changes highlighted
- [ ] Issue/PR numbers linked
- [ ] Version number follows SemVer
- [ ] Date in ISO format (YYYY-MM-DD)
- [ ] Entries grouped by type
- [ ] Security fixes prominently noted
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: 322kUpdated Claude CodeCodexVerifiedInstall
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: 198kUpdated Claude CodeCodexVerifiedInstall
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: 198kUpdated Claude CodeCodexVerifiedInstall
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: 198kUpdated Claude CodeCodexVerifiedInstall