skills.rest
ClyptAI
ClyptAIOFFICIAL
Explore all skills by this author →
GitHub

document-release

Update project documentation and changelog to reflect shipped changes.

Updated Mar 8, 2026
Search Tags:#automation#documentation#diff#docs#CHANGELOG#version#post-ship
One-click install
npx skills add https://github.com/ClyptAI/Clypt-Backend --skill document-release-clyptai
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/ClyptAI/Clypt-Backend/tree/main/.agents/skills/gstack/document-release
Command: npx skills add https://github.com/ClyptAI/Clypt-Backend --skill document-release-clyptai

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship project updates require manual edits to multiple docs; this skill automates syncing shipped changes across docs and changelog, reducing drift across the project.

Core Features & Use Cases

  • Update README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to reflect what shipped.
  • Polish CHANGELOG language, clean up TODOS, and optionally bump VERSION when needed.
  • Proactively suggest documentation updates after a PR is merged or code is shipped.

Quick Start

Invoke this skill after a release to sync docs across the project and update the changelog.

Frequently Asked Questions about document-release

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automate documentation updates after a release?▼

You can automate post-ship documentation updates by invoking a skill that reads project docs, compares them to shipped changes, and applies corrections across README, ARCHITECTURE, and CONTRIBUTING files to reduce manual drift.

What is the best way to sync my CHANGELOG with shipped code changes?▼

Syncing your CHANGELOG with shipped code involves comparing project documentation against recent changes and polishing the changelog language to accurately match what shipped during the release process.

Can I automatically clean up TODOS and bump VERSION in my project docs?▼

Yes, you can clean up TODOS and optionally bump VERSION in your project docs by running an automated post-ship documentation sync that updates these files based on the latest shipped changes.

How does proactive documentation update suggestion work after a PR is merged?▼

Proactive documentation update suggestions trigger automatically after a PR is merged or code is shipped, identifying discrepancies between your project docs and the new state to recommend necessary corrections.

Do I need to manually update CLAUDE.md after shipping new code?▼

No, you do not need to manually update CLAUDE.md after shipping code; an automated documentation sync can read the shipped changes and apply corrections to CLAUDE.md to match the current project state.

What are the limitations of automating post-ship docs sync?▼

Automating post-ship docs sync relies on reading project docs and comparing them to shipped changes; its effectiveness is limited by the accuracy of the existing documentation and the clarity of the recent code diffs.

Related Skills

Explore More Content & Communication Skills→
harusame0616harusame0616

creating-pr

Create or update GitHub pull requests from commit history and code diffs.

Community
Advanced
t0labt0lab
2

release

Analyze Conventional Commits to draft changelogs and create release commits and tags.

Official
Advanced
SpagesticSpagestic
4

markdown-helper

Lint and fix Markdown files using markdownlint-mcp for style consistency.

Community
Basic
zero-rehqzero-rehq

api-documentation-generator

Generate OpenAPI specs from TypeScript Express, Next.js, and Fastify source code.

Community
Intermediate