skills.rest
simbotNL
simbotNLCOMMUNITY
Explore all skills by this author →
GitHub

document-release

Update README and key documents after a software release.

Updated Aug 23, 2026
Search Tags:#project management#documentation#version control#software release#post-ship
One-click install
npx skills add https://github.com/simbotNL/BT --skill document-release-simbotnl
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/simbotNL/BT/tree/main/plugins/gstack/document-release
Command: npx skills add https://github.com/simbotNL/BT --skill document-release-simbotnl

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This Skill streamlines the process of updating documentation after a software release, ensuring that the README and other key documents reflect the latest changes and status of the project.

Core Features & Use Cases

  • Documentation Sync: Updates README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to match the latest project status.
  • Change Detection: Identifies and highlights the changes made since the last release.
  • Proactive Updates: Can be invoked proactively to keep documentation up-to-date with ongoing changes.
  • Use Case: After merging a pull request or shipping a new version, this Skill can automatically update the documentation to reflect the new features, fixes, and other changes.

Quick Start

Run the document-release skill to update documentation after a release.

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

Automating documentation updates after a software release requires analyzing version control commit histories to sync README and key project files with the latest changes. This process identifies recent modifications and rewrites documents to match the current project status.

What is the best way to sync my README with recent code commits?▼

Syncing your README with recent code commits involves detecting changes since the last release and applying them to project documentation. This ensures key documents accurately reflect new features, bug fixes, and architectural shifts without manual intervention.

Can I update project documentation proactively during ongoing development?▼

Updating project documentation proactively is possible by invoking the update process before an official release. This keeps README, ARCHITECTURE, and CONTRIBUTING files continuously aligned with ongoing project changes and version control history.

Does automating post-ship documentation work with my version control system?▼

Automating post-ship documentation works with version control systems that maintain commit histories. It requires direct access to your project's codebase and existing documentation files to detect changes and apply updates accurately.

What key documents should be updated following a new software version release?▼

Following a software version release, key documents to update include README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md files. Syncing these documents ensures the project's documentation reflects the newest features, fixes, and overall status.

Related Skills

Explore More Software Engineering Skills→
dan323dan323
7

changelog

Generate and update CHANGELOG.md files from git history and commit details.

Community
Intermediate
SonarSourceSonarSource
6

automated-release-setup

Automate release workflow setup with GitHub Actions, Jira, Slack, and vault secrets.

Official
Advanced
CharGrnmnCharGrnmn
1

gpd-complete-milestone

Mark completed research milestones, archive documents, and tag them in version control.

Community
Advanced
smarmen86smarmen86

document-release

Synchronize README, architecture, and changelog files after code deployment.

Community
Advanced