changelog-writer

Generate architecture-focused milestone changelogs with Mermaid diagrams and schema tables.

1|Updated Mar 7, 2026
One-click install
npx skills add https://github.com/y0ncha/aptitude-client --skill changelog-writer-y0ncha
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: changelog-writer
Source: https://github.com/y0ncha/aptitude-client/tree/main/.agents/skills/changelog-writer
Command: npx skills add https://github.com/y0ncha/aptitude-client --skill changelog-writer-y0ncha

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Converts implementation artifacts and plans into concise, auditable milestone changelogs that clearly map delivered behaviors to concrete repository evidence, reducing manual documentation effort and mismatched claims.

Core Features & Use Cases

  • Architecture-focused changelogs: Produce short, technical milestone entries suitable for docs/changelog that include design rationale and tradeoffs.
  • Verified code linking: Map each delivered behavior to specific implementation files, endpoints, migrations, and tests with deep links.
  • Diagrams and schema references: Insert at least one Mermaid architecture or flow diagram and present database/schema details in tables that explain each field's role.
  • Use Case: After merging a milestone, generate the changelog that links the client PRD, implemented routes, core services, persistence migrations, and relevant tests.

Quick Start

Draft a concise milestone changelog for the implemented feature linking the plan and the most specific implementation files, include a Mermaid flowchart, and add schema tables that explain each field's purpose.

Frequently Asked Questions about changelog-writer

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

FAQPage Schema
How do I generate architecture changelogs with mermaid diagrams and code links?

To generate architecture changelogs, map implemented behaviors to concrete repository files, routes, migrations, and tests. Include at least one mermaid diagram and schema tables with explicit field role explanations to ensure claims are verifiable through deep links.

What is the best way to document release milestones with schema tables and file references?

Documenting release milestones requires linking the client PRD to implemented routes, core services, persistence migrations, and relevant tests. Present database schema details in tables explaining each field's purpose alongside a concise bullet-oriented output.

How do I create mermaid diagrams for software engineering release notes?

Create mermaid diagrams for release notes by inserting at least one architecture or flow diagram that maps delivered behaviors to specific implementation files and endpoints. This visual mapping reduces manual documentation effort and mismatched claims.

Does generating milestone changelogs require explicit repository file links for verification?

Yes, generating milestone changelogs requires verification of claims via repository file links. Mapping each delivered behavior to specific implementation files, endpoints, migrations, and tests ensures the architecture changelog is auditable and reduces mismatched claims.

Can I use this approach for sprint milestone documentation and implementation reviews?

Yes, this approach suits software engineering releases, sprint milestones, and implementation reviews. It converts implementation artifacts and plans into concise, auditable milestone changelogs that map delivered behaviors to concrete repository evidence.

What are the limitations of using concise bullet-oriented architecture changelogs?

Concise bullet-oriented architecture changelogs require inclusion of at least one mermaid diagram and schema tables with explicit field role explanations. Without these structural elements and deep file links, the documentation may lack sufficient auditable evidence for implementation reviews.