doc-update
Post-ship documentation sync across all project docs. Use when: after shipping features, updating APIs, changing behavior.
- License 许可
- Apache-2.0
- 所属仓库
- bravew/Neumar
- 最近更新
- 2026-11-14
- Stars
- ★ 12
- Forks
- 4
01 前言 Front Matter
- icon
- file-text
- name
- doc-update
- trigger
- /doc-update
- version
- 1.0.0
- category
- development
- description
- Post-ship documentation sync across all project docs. Use when: after shipping features, updating APIs, changing behavior.
03 SKILL.md 正文
When generating output, use the user's preferred language for all headings, labels, and prose.
Overview
Ensures documentation stays in sync with code changes. Runs after shipping to find and update all docs affected by recent changes.
Phase 1: Identify What Changed
- Review recent commits or the PR being documented
- List all behavioral changes:
- New features or endpoints
- Changed API contracts
- Removed functionality
- Configuration changes
- New dependencies
Phase 2: Find Affected Documentation
Scan these locations for references to the changed code:
- README.md — Project overview, setup instructions, getting started
- API documentation — Endpoint docs, request/response schemas
- Configuration docs — Environment variables, config files
- Architecture docs — System design, data flow diagrams
- Inline code comments — JSDoc, docstrings, header comments
- Changelogs — CHANGELOG.md, release notes
- Migration guides — If breaking changes were introduced
Phase 3: Update Documentation
For each affected document:
- Read the existing content — Understand what's there
- Identify the delta — What's now wrong or missing?
- Make the minimum edit — Don't rewrite what's still correct
- Verify accuracy — Cross-reference with the actual code
- Check examples — Do code examples still work?
Writing Guidelines
- Be specific — Use exact function names, file paths, config keys
- Show, don't tell — Include code examples for anything non-obvious
- Update, don't append — Fix the existing docs rather than adding footnotes
- Keep it current — Remove references to deprecated features
Phase 4: Verify Completeness
- [ ] All new features documented
- [ ] All changed behavior documented
- [ ] All removed features' references cleaned up
- [ ] Code examples tested and working
- [ ] Internal links not broken
- [ ] No stale screenshots or diagrams
Output Format
## Documentation Update Report
### Changes Documented
| File | Change | Status |
|------|--------|--------|
| README.md | Added new feature section | ✅ Updated |
| docs/api.md | Updated endpoint schema | ✅ Updated |
### Files That May Need Manual Review
- [file]: [reason it needs human judgment]
04 同仓库更多 Skills
yt-dlp
A robust CLI wrapper for yt-dlp to download videos, playlists, and audio from YouTube and thousands of other sites. Supports format selection, quality control, metadata embedding, and cookie authentication.
weather
Get current weather and forecasts (no API key required).
video-editing
Video Mode editing guidance for agentic storyboard, timeline, caption, audio, render, and publish work through video_* MCP tools.
video-edit
Conversational video editing workflow for cuts, transcript-based edits, overlays, captions, subtitle burn-in, and render planning with ffmpeg. Use when the user asks to edit video by instruction, cut silence or words, add subtitles, add overlays, transcribe video, or render a final clip.
skill-creator
Create new skills, modify and improve existing skills, and measure skill performance. Use when users want to create a skill from scratch, update or optimize an existing skill, run evals to test a skill, benchmark skill performance with variance analysis, or optimize a skill's description for better triggering accuracy.
ship
Full shipping workflow: test, review, version, changelog, and PR creation. Use when: preparing to ship code, creating releases, merging PRs.