release-notes-one-pager

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Release Notes One-Pager Skill

单页版本发布说明Skill

Produce a single-page release notes document in HTML.

生成单页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.

release-notes-one-pager/
├── SKILL.md                    ← 本文件
├── example.html                ← 质量标准与样式参考
├── assets/
│   └── template.html           ← 本地种子文件，将复制到项目的index.html
└── references/
    ├── checklist.md            ← P0/P1/P2检查项
    └── layouts.md              ← 本地板块骨架模板

除非用户明确要求定制结构，否则请勿从零开始编写CSS。

Workflow

工作流程

Step 0 — Pre-flight

步骤0 — 前期准备

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

阅读
```
assets/template.html
```
文件。
阅读
```
references/layouts.md
```
文件。
阅读当前的
```
DESIGN.md
```
文件，并将其映射到六个
```
:root
```
变量。

Step 1 — Start from the shared seed

步骤1 — 从共享种子文件开始

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

将

assets/template.html

复制到项目的

index.html

。

更新以下内容：

```
<title>
```
标签内容
顶部导航栏的logo文本
顶部导航栏的链接标签（链接目标已预先设置为
```
#added
```
、
```
#fixed
```
、
```
#upgrade-note
```
）
顶部导航栏的CTA标签及
```
href
```
目标；若没有实际目标，则完全省略顶部导航栏的CTA
通过添加匹配的板块
```
id
```
属性，确保顶部导航栏的链接目标存在

Step 2 — Build release-note structure

步骤2 — 构建版本发布说明结构

Inside

<main id="content">

, compose this section order:

Hero (Layout 1 or 2): version, date, one-sentence summary.
Added (use Layout 7 log-list; section root must include
```
id="added"
```
).
Fixed (use Layout 7 log-list; section root must include
```
id="fixed"
```
).
Breaking changes (use Layout 7 log-list, or one row explicitly saying "None"; section root must include
```
id="breaking-changes"
```
).
Known issues (Layout 7 or card list; section root must include
```
id="known-issues"
```
).
Upgrade note (short steps list or explicit no-action statement; section root must include
```
id="upgrade-note"
```
).
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.

在

<main id="content">

内部，按以下顺序组合板块：

英雄区（布局1或2）：版本号、日期、一句话概述。
新增功能（使用布局7的日志列表；板块根元素必须包含
```
id="added"
```
）。
修复内容（使用布局7的日志列表；板块根元素必须包含
```
id="fixed"
```
）。
破坏性变更（使用布局7的日志列表，或添加明确标注“无”的单行内容；板块根元素必须包含
```
id="breaking-changes"
```
）。
已知问题（使用布局7或卡片列表；板块根元素必须包含
```
id="known-issues"
```
）。
升级说明（简短步骤列表或明确的无需操作说明；板块根元素必须包含
```
id="upgrade-note"
```
）。
结尾CTA条（布局6）。

对于生成的HTML中的所有CTA（顶部导航栏、英雄区、结尾条），将可见标签和

href

目标替换为真实、安全的值。若没有实际目标，则完全省略该CTA——请勿使用

href="#"

这类占位符、误导性页面锚点或

REPLACE_WITH_REAL_URL

。英雄区的CTA为可选内容；仅当存在实际目标时才添加。

Step 3 — Honesty rules for missing details

步骤3 — 缺失细节的处理规则

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.

若用户未提供相关细节，请勿自行编造。请使用明确的占位符：

概述：
```
No summary provided.
```
新增功能：
```
No additions provided
```
修复内容：
```
No fixes provided
```
破坏性变更：
```
None
```
已知问题：
```
None reported
```

升级说明：

No upgrade actions required based on provided information

若版本号或发布日期缺失，使用

—

并标注对应字段，而非猜测。

Step 4 — Self-check

步骤4 — 自我检查

Run

references/checklist.md

. Every P0 must pass.

执行

references/checklist.md

中的检查项。所有P0检查项必须通过。

Step 5 — Emit artifact

步骤5 — 生成产物

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>

将输出内容包裹为以下格式：

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

在产物前添加一句话说明。

</artifact>

之后不得添加任何内容。