Skip to content
Skillpedia
Writing101k · #759

release-notes-one-pager

Creates a one-page summary of product updates. It highlights new features, fixes, and known issues.

What it does

This tool creates a release notes document on a single HTML page. It organizes information into sections like highlights, fixes, breaking changes, and known issues.

When to use it

  • ✓When releasing a new software version.
  • ✓To inform the team about updates and fixes.
  • ✓To document important changes for users.

Example of what to ask your AI

“Create release notes for app version 2.5, released today. There were UI improvements and we fixed a bug that crashed the app on save.”

Want more? Open the sections below.

How to use

The easiest way: copy the message below and paste it into Claude, ChatGPT, Cursor or any AI. It reads the skill and follows the instructions.

Skill link

https://github.com/nexu-io/open-design/blob/main/skills/release-notes-one-pager/SKILL.md

Ready-to-paste message

Use this skill to help me: https://github.com/nexu-io/open-design/blob/main/skills/release-notes-one-pager/SKILL.md Read the SKILL.md file at that link and follow its instructions for my task.
How it works

The tool takes an HTML template and fills it with the information you provide. It ensures all necessary sections are present, even if there's no news for a particular section.

Installation

Easiest way: copy the skill link and paste it into Claude, ChatGPT or Cursor asking it to follow the instructions.

In the terminal (Claude Code, Codex, Cursor), in your project folder:

npx skills add nexu-io/open-design --skill release-notes-one-pager

Or download just the file:

curl -L https://raw.githubusercontent.com/nexu-io/open-design/main/skills/release-notes-one-pager/SKILL.md -o SKILL.md
Technical content (original SKILL.md)

Original text by the author, straight from GitHub.

Release Notes One-Pager Skill

Produce a single-page release notes document in HTML.

Resource map

release-notes-one-pager/
├── SKILL.md                    ← this file
├── example.html                ← quality bar and style reference
├── assets/
│   └── template.html           ← local seed file to copy to project index.html
└── references/
    ├── checklist.md            ← P0 / P1 / P2 gates
    └── layouts.md              ← local section skeletons

Do not write CSS from scratch unless the user explicitly asks for a bespoke structure.

Workflow

Step 0 — Pre-flight

  1. Read assets/template.html.
  2. Read references/layouts.md.
  3. Read active DESIGN.md and map it to the six :root variables.

Step 1 — Start from the shared seed

Copy assets/template.html to project index.html.

Update:

  • <title>
  • topnav logo text
  • topnav link labels (destinations are pre-wired to #added, #fixed, #upgrade-note)
  • topnav CTA label and href destination, or omit the topnav CTA entirely if no real destination exists
  • ensure the topnav link targets exist by adding matching section id attributes

Step 2 — Build release-note structure

Inside <main id="content">, compose this section order:

  1. Hero (Layout 1 or 2): version, date, one-sentence summary.
  2. Added (use Layout 7 log-list; section root must include id="added").
  3. Fixed (use Layout 7 log-list; section root must include id="fixed").
  4. Breaking changes (use Layout 7 log-list, or one row explicitly saying "None"; section root must include id="breaking-changes").
  5. Known issues (Layout 7 or card list; section root must include id="known-issues").
  6. Upgrade note (short steps list or explicit no-action statement; section root must include id="upgrade-note").
  7. Closing CTA strip (Layout 6).

For every CTA in the emitted HTML (topnav, hero, closing strip), replace both the visible label and the href destination with real, safe values. If no real destination is available, omit the CTA entirely—do not use a placeholder such as href="#", a misleading page-anchor, or REPLACE_WITH_REAL_URL. Hero CTAs are optional; only add them when real destinations exist.

Step 3 — Honesty rules for missing details

If the user does not provide details, do not invent them. Write explicit placeholders:

  • Summary: No summary provided.
  • Added: No additions provided
  • Fixed: No fixes provided
  • Breaking changes: None
  • Known issues: None reported
  • Upgrade note: No upgrade actions required based on provided information

If release version or date is missing, use — and label the field rather than guessing.

Step 4 — Self-check

Run references/checklist.md. Every P0 must pass.

Step 5 — Emit artifact

Wrap output as:

<artifact identifier="release-notes-one-pager" type="text/html" title="Release Notes">
<!doctype html>
<html>...</html>
</artifact>

One sentence before the artifact. Nothing after </artifact>.

FAQ

What happens if I don't provide details for a section?

The tool will add text indicating no information is available for that section, such as 'No additions provided' or 'No breaking changes'.

Can I customize the appearance?

The tool uses a predefined HTML template and does not create CSS from scratch unless a custom structure is explicitly requested.

What are 'Breaking changes'?

These are changes that might break existing functionality, requiring the user or developer to make adjustments.

Details

Original description by the author

Release notes one-page HTML with highlights, Added, Fixed, Breaking changes, Known issues, and Upgrade note. Writes explicit "None" style sections whenever the user does not provide details.

repo: nexu-io/open-design

Popularity

GitHub stars
101k
Ranking position
#759
License
Apache-2.0
Updated
10/16/2026

Is this skill useful?

0

Sign in to vote.

Comments

  • …

More skills from this repository

Similar skills