document-release

Name: document-release
Availability: InStock
Author: wangfeiv

Update project documentation files after each release using Bash and Read.

Updated Oct 29, 2013

Search Tags:#automation #changelog #versioning #documentation #release

Ready to run

npx skills add https://github.com/wangfeiv/GitProjects --skill document-release-wangfeiv

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/wangfeiv/GitProjects/tree/main/skills/gstack/document-release
Command: npx skills add https://github.com/wangfeiv/GitProjects --skill document-release-wangfeiv

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill automates the process of updating project documentation to reflect the latest shipped changes, ensuring all related files are accurate and consistent.

Core Features & Use Cases

Documentation Synchronization: Reads all project docs, cross-references recent diffs, and updates key files like README and architecture documents to match the current shipped state.
Changelog Polishing: Enhances the tone and clarity of changelog entries, making release notes more user-friendly.
Todo and Version Management: Cleans up TODO items and prompts for version bumps if necessary, maintaining project health for releases.

Quick Start

Run the skill to automatically scan all project documentation files and update their content based on the latest code changes and shipped artifacts.

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?▼

Automating documentation updates after a release requires scanning recent code diffs and applying those changes to README, architecture, and changelog files. This ensures all project documentation accurately reflects the latest shipped state without manual editing.

What is the best way to keep a changelog and README synchronized with shipped code?▼

Keeping a changelog and README synchronized involves cross-referencing recent diffs across all project documents and polishing changelog entries. This verifies cross-document consistency and enhances the tone of release notes for user-friendliness.

How does changelog polishing improve release notes?▼

Changelog polishing improves release notes by reading raw shipped changes and refining their tone and clarity. This makes the final changelog entries more user-friendly and ensures the documentation accurately communicates the latest updates.

Can I use Bash scripts to process diffs for versioning and TODO cleanup?▼

Yes, you can use Bash scripts to process code diffs for versioning and TODO cleanup. The process reads project diffs and file structures to prompt for version bumps and clean up stale TODO items automatically.

Why does my project documentation show outdated architecture after shipping?▼

Project documentation shows outdated architecture when files are not cross-referenced with recent code changes. Automating the reading of project diffs and updating architecture documents ensures consistency across all shipped artifacts.