skills.rest
SakshamKandel
SakshamKandelCOMMUNITY
Explore all skills by this author →
GitHub

document-release

Audit project documentation against code diffs and update READMEs, ARCHITECTURE.md, CONTRIBUTING.md, AGENTS.md, and CHANGELOG.

Updated Apr 24, 2026
Search Tags:#changelog#architecture#versioning#documentation#audit#diff#readmes
One-click install
npx skills add https://github.com/SakshamKandel/Salt-Route-Consulting- --skill document-release-sakshamkandel
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/SakshamKandel/Salt-Route-Consulting-/tree/main/.agents/skills/document-release
Command: npx skills add https://github.com/SakshamKandel/Salt-Route-Consulting- --skill document-release-sakshamkandel

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship changes often drift in documentation. This skill audits a project’s docs and aligns READMEs, ARCHITECTURE, CONTRIBUTING, AGENTS.md, and CHANGELOG with shipped changes, ensuring consistency and clarity.

Core Features & Use Cases

  • Audit and cross-reference documentation against code diffs.
  • Update READMEs, ARCHITECTURE.md, CONTRIBUTING.md, and CHANGELOG for shipped changes.
  • Surface documentation debt, automate small polish tasks, and optionally bump the version.

Quick Start

Automatically run after a PR merge to synchronize and polish documentation across the repository.

Frequently Asked Questions about document-release

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

FAQPage Schema
How do I keep READMEs and CHANGELOGs synced after shipping code changes?▼

To keep READMEs and CHANGELOGs synced after shipping, you can audit project documentation against code diffs and automatically update multiple doc artifacts to reflect the shipped changes for consistency.

What is the best way to audit documentation debt against code diffs?▼

Auditing documentation debt against code diffs involves cross-referencing shipped changes with existing docs, surfacing inconsistencies, and generating a report to highlight areas requiring manual or automated polishing.

Can I automatically update ARCHITECTURE.md and CONTRIBUTING.md when a PR is merged?▼

Yes, you can automatically update ARCHITECTURE.md and CONTRIBUTING.md when a PR is merged by running an audit script that aligns documentation artifacts with the integrated code changes.

Does post-ship documentation polishing support optional version bumping?▼

Post-ship documentation polishing supports optional version bumping alongside changelog updates, ensuring that release versions and their corresponding documentation remain accurately aligned.

What is a Diataxis coverage map for documentation auditing?▼

A Diataxis coverage map is a framework used during documentation auditing to categorize and evaluate docs across tutorials, how-to guides, references, and explanations, ensuring comprehensive coverage.

Related Skills

Explore More Content & Communication Skills→
jiyeol-leejiyeol-lee
1

review

Analyze code changes for quality, regression, documentation, and performance findings.

Community
Intermediate
jewbetchajewbetcha
115

changelog-generator

Generate user-facing release notes from Git commit history.

Community
Basic
divad12divad12
25

sync-architecture

Detect architecture drift and update the Mermaid diagram in docs/ai/architecture.md.

Community
Intermediate
reomgitreomgit

document-release

Update project documentation files and report documentation debt after software releases.

Community
Advanced