mcpField
R
release-notes-one-pager

release-notes-one-pager

github.com/nexu-io文档处理104.6k2.8k 次安装今天更新
代码仓库

关于 release-notes-one-pager

release-notes-one-pager 是用于生成单页 HTML 版本说明文档的技能,面向编写产品发布记录的工作流。它提供模板、布局参考与检查清单,并要求对缺失信息使用明确占位内容。

主要功能

  1. 01生成单页 HTML 版本说明
  2. 02使用共享 HTML 模板
  3. 03按布局组织发布内容
  4. 04检查文档完整性
  5. 05缺失信息采用明确占位

适用场景

  1. 01制作产品版本发布文档
  2. 02整理新增与修复内容
  3. 03记录破坏性变更和已知问题
  4. 04编写升级说明

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/nexu-io/open-design --skill release-notes-one-pager

安装后在 Claude Code 中输入/release-notes-one-pager确认已加载。

包含的文件

除 SKILL.md 外,安装时一起下载的参考资料和脚本。

example.html
assets/
template.html
references/
checklist.md
layouts.md

详细介绍

Release Notes One-Pager Skill

生成一份单页 HTML 发行说明文档。

资源映射

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

除非用户明确要求定制结构,否则不要从头编写 CSS。

工作流

步骤 0 — 前置检查
  1. 阅读 assets/template.html。
  2. 阅读 references/layouts.md。
  3. 阅读当前生效的 DESIGN.md,并将其映射到六个 :root 变量。
步骤 1 — 从共享种子文件开始

将 assets/template.html 复制到项目的 index.html。

更新:

  • <title>
  • topnav 标志文本
  • topnav 链接标签(目标已预先设置为 #added、#fixed、#upgrade-note)
  • topnav CTA 标签和 href 目标;如果没有实际目标,则完全省略 topnav CTA
  • 确保 topnav 链接目标存在,方法是添加匹配的 section id 属性
步骤 2 — 构建发行说明结构

在 <main id="content"> 内,按以下顺序组织各部分:

  1. Hero(布局 1 或 2):版本、日期、一句话摘要。
  2. Added(使用布局 7 的 log-list;section 根节点必须包含 id="added")。
  3. Fixed(使用布局 7 的 log-list;section 根节点必须包含 id="fixed")。
  4. Breaking changes(使用布局 7 的 log-list,或添加一行明确写明 "None";section 根节点必须包含 id="breaking-changes")。
  5. Known issues(布局 7 或卡片列表;section 根节点必须包含 id="known-issues")。
  6. Upgrade note(简短步骤列表或明确说明无需操作;section 根节点必须包含 id="upgrade-note")。
  7. 结尾 CTA 横幅(布局 6)。

对于输出 HTML 中的每个 CTA(topnav、hero、结尾横幅),都要将可见标签和 href 目标替换为真实且安全的值。如果没有实际目标,则完全省略 CTA——不要使用 href="#"、具有误导性的页面内锚点或 REPLACE_WITH_REAL_URL 等占位符。Hero CTA 为可选项;仅在有实际目标时添加。

步骤 3 — 缺失信息的诚信规则

如果用户未提供详细信息,不要编造。请使用明确的占位文本:

  • 摘要: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

如果缺少发行版本或日期,请使用 — 并标明字段,而不要猜测。

步骤 4 — 自检

运行 references/checklist.md。所有 P0 项都必须通过。

步骤 5 — 输出产物

将输出包装为:

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

在产物前写一句话。</artifact> 之后不要写任何内容。

评论

支持 Markdown