Installs into .claude/skills of the current project.
Are you the author of Documentation?
Add the live security badge to your README. It updates with every re-scan.
[](https://www.skillsdirectory.com/skills/zjunlp-documentation)
---
name: documentation
description: Feature documentation and release notes patterns. Use when documenting changes, writing PR descriptions, or preparing releases.
---
# Documentation
## PR Description
```markdown
## Summary
- What this PR does (bullet points)
## Test Plan
- How to verify it works
## Related Issues
- Resolves #123
```
## Changelog Entry
```markdown
### [VERSION] - [DATE]
#### New Features
- **Feature Name**: Brief description
#### Improvements
- **Improvement**: What changed and why
#### Bug Fixes
- **Fix**: What was broken (#issue)
#### Breaking Changes
- **Change**: What breaks, migration steps
```
## Feature Documentation
When documenting a feature, cover:
**User Impact**
- What capability does this add?
- How do users access it?
**Technical Changes**
- API changes (endpoints, params)
- SDK changes (new methods)
- Database migrations
- Config changes
**Breaking Changes** (if any)
- What breaks
- Migration steps
## Key Files
- `CHANGELOG.md` - Main changelog
- `.github/release-drafter.yml` - Release template
## Style
- User perspective, not implementation details
- Specific (version numbers, dates)
- Code examples for API/SDK changes
- Concise - link to docs, don't duplicate
