界面已本地化;技能介绍与说明文档按所选语言由 AI 自动翻译,代码、命令、路径和专业术语保留原文,以原作者文档为准。
探索技能
文档与办公 · SKILL.md

documentation

documentation

【文档与办公】Feature documentation and release notes patterns. Use when documenting changes, writing PR descriptions, or preparing releases.

独立 GitHub 快照 · 自动分类 · 以原作者文档为准

技能说明

GitHub

name: documentation description: Feature documentation and release notes patterns. Use when documenting changes, writing PR descriptions, or preparing releases.

Documentation

PR Description

## Summary
- What this PR does (bullet points)

## Test Plan
- How to verify it works

## Related Issues
- Resolves #123

Changelog Entry

### [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
我的收藏