document-release

Update project documentation to reflect shipped code changes.

1|2|Updated Jan 4, 2024
One-click install
npx skills add https://github.com/NaKMiers/Port4lio --skill document-release-nakmiers
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/NaKMiers/Port4lio/tree/main/.agents/skills/document-release
Command: npx skills add https://github.com/NaKMiers/Port4lio --skill document-release-nakmiers

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

After a ship, project documentation often drifts out of date. This skill ensures docs reflect what shipped by reading diffs and updating key docs (README, ARCHITECTURE, CONTRIBUTING, AGENTS.md), polishing CHANGELOG language, cleaning up TODOS, and optionally bumping the VERSION. It keeps teams aligned and speeds onboarding by maintaining accurate documentation after every release.

Core Features & Use Cases

  • Reads project docs and cross-references shipped changes against the diff to identify what needs updating.
  • Updates README, ARCHITECTURE, CONTRIBUTING, and AGENTS.md to reflect the shipped state and adds or adjusts content as needed.
  • Polishes CHANGELOG language for clarity and consistency.
  • Cleans up TODOS to reflect current work and removes stale items.
  • Optionally bumps the VERSION to reflect new release state.
  • Proactively suggests documentation updates after a PR is merged or code is shipped to prevent drift.

Quick Start

Run the document-release skill after shipping to synchronize docs with the latest changes.

Frequently Asked Questions about document-release

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

FAQPage Schema
How do I update README and ARCHITECTURE docs after shipping code changes?

To update README and ARCHITECTURE docs after shipping, this skill reads your project diffs to identify what changed and automatically adjusts the documentation to reflect the shipped state. It ensures your post-ship docs stay synced with the actual codebase.

What is the best way to keep documentation from drifting after a release?

Keeping documentation from drifting after a release requires cross-referencing shipped diffs against existing docs. This skill proactively suggests updates after a PR is merged, polishing CHANGELOG language and cleaning TODOS to maintain accurate documentation.

How do I automatically polish CHANGELOG entries based on merged PRs?

To automatically polish CHANGELOG entries based on merged PRs, this skill reads the shipped diff and refines the CHANGELOG language for clarity and consistency. It identifies what shipped and adjusts the text to accurately reflect the new release state.

Can I automatically clean up TODOS and bump VERSION when a PR is merged?

Yes, you can clean up TODOS and bump VERSION when a PR is merged. This skill cross-references the shipped diff to remove stale TODO items and optionally bumps the VERSION file to reflect the new release state automatically.

Does this documentation update tool work without external dependencies?

Yes, this documentation update tool works without external dependencies. It operates independently by reading your project diffs and existing docs to synchronize README, ARCHITECTURE, CONTRIBUTING, and AGENTS.md files after a ship.