skills.rest
porcupine-md
porcupine-mdOFFICIAL
Explore all skills by this author →
GitHub

documenting-release

Analyze project diffs to update README, ARCHITECTURE, and CHANGELOG documentation.

11|2|Updated Apr 7, 2026
Search Tags:#changelog#architecture#documentation#readme#diff-analysis
One-click install
npx skills add https://github.com/porcupine-md/jonggrang --skill documenting-release
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documenting-release
Source: https://github.com/porcupine-md/jonggrang/tree/main/skills/core/documenting-release
Command: npx skills add https://github.com/porcupine-md/jonggrang --skill documenting-release

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Cross-reference changes across documentation to ensure READMEs, ARCHITECTURE.md, and CHANGELOG.md stay current before each feature release.

Core Features & Use Cases

  • Audit documentation against diffs to ensure changes are reflected in READMEs, ARCHITECTURE.md, and CHANGELOG.md.
  • Polish changelog entries to emphasize user-facing capabilities and release impact.
  • Cross-check consistency between README, ARCHITECTURE, and CHANGELOG to avoid factual discrepancies.

Quick Start

Run the documentation-audit command to align all docs with the latest feature changes.

Frequently Asked Questions about documenting-release

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

FAQPage Schema
How do I keep my README and CHANGELOG accurate after new feature releases?▼

To keep documentation accurate, analyze project diffs to identify changes affecting README and CHANGELOG, then apply targeted factual updates to ensure all files reflect the latest features.

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

The best way to audit architecture documentation is to cross-reference project diffs against ARCHITECTURE.md to identify affected sections and apply targeted factual updates for cross-document consistency.

How do I write changelog entries that emphasize user-facing release impact?▼

To write effective changelog entries, polish the identified diff analysis by summarizing technical changes into concise, user-facing capabilities and release impacts for the changelog.

How do I prevent factual discrepancies between README and CHANGELOG files?▼

To prevent factual discrepancies between README and CHANGELOG files, cross-check consistency across all documentation after applying updates to ensure both files align with the actual project diffs.

Can I generate a concise changelog summary directly from project diffs?▼

Yes, you can generate a concise changelog-ready summary by analyzing project diffs to identify documentation changes and polishing the release notes for user clarity.

Related Skills

Explore More Software Engineering Skills→
ajsai47ajsai47
11

document-release

Update project markdown documentation by cross-referencing git diffs after code commits.

Community
Advanced
nklischnklisch
7

release

Draft changelog entries from commits and execute the project's release process.

Community
Advanced
VoDaiLoczVoDaiLocz
24

lint-and-validate

Automate linting and static analysis of code in CI pipelines.

Community
Intermediate
wangfeivwangfeiv

document-release

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

Community
Intermediate