release-notes-one-pager について
release-notes-one-pagerは、1ページのHTMLリリースノートを作成するスキルです。共通テンプレートやレイアウト資料、チェック項目に沿って構成し、不足情報には明示的なプレースホルダーを使います。
主な機能
- 011ページのHTMLリリースノート作成
- 02共通HTMLテンプレートの利用
- 03レイアウトに沿った項目構成
- 04文書の完全性チェック
- 05不足情報への明示的なプレースホルダー
活用シーン
- 01製品リリース文書の作成
- 02追加項目と修正内容の整理
- 03破壊的変更と既知の問題の記録
- 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.htmlassets/template.htmlreferences/checklist.mdlayouts.md詳細
リリースノートのワンページスキル
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 — 事前確認
assets/template.htmlを読みます。references/layouts.mdを読みます。- 有効な
DESIGN.mdを読み、6 つの:root変数に対応づけます。
ステップ 1 — 共有シードから開始
assets/template.html をプロジェクトの index.html にコピーします。
次を更新します:
<title>- topnav のロゴテキスト
- topnav のリンクラベル(リンク先はあらかじめ
#added、#fixed、#upgrade-noteに設定されています) - topnav の CTA ラベルと
hrefのリンク先。実際のリンク先がない場合は、topnav の CTA を完全に省略します - 対応するセクションの
id属性を追加し、topnav のリンク先が存在することを確認します
ステップ 2 — リリースノートの構成を作成
<main id="content"> 内に、次の順序でセクションを構成します:
- ヒーロー(レイアウト 1 または 2):バージョン、日付、1 文の概要。
- 追加(レイアウト 7 のログリストを使用。セクションのルート要素に
id="added"を含めます)。 - 修正(レイアウト 7 のログリストを使用。セクションのルート要素に
id="fixed"を含めます)。 - 破壊的変更(レイアウト 7 のログリストを使用するか、「なし」と明記した 1 行を記載します。セクションのルート要素に
id="breaking-changes"を含めます)。 - 既知の問題(レイアウト 7 またはカードリストを使用。セクションのルート要素に
id="known-issues"を含めます)。 - アップグレードに関する注意(短い手順リスト、または対応不要であることを明記します。セクションのルート要素に
id="upgrade-note"を含めます)。 - 締めくくりの CTA ストリップ(レイアウト 6)。
出力する HTML のすべての CTA(topnav、ヒーロー、締めくくりのストリップ)について、表示ラベルと href のリンク先の両方を、実際に有効で安全な値に置き換えます。実際のリンク先がない場合は、CTA を完全に省略します。href="#"、誤解を招くページ内アンカー、REPLACE_WITH_REAL_URL などのプレースホルダーは使用しないでください。ヒーローの CTA は任意です。実際のリンク先がある場合にのみ追加してください。
ステップ 3 — 詳細が不足している場合の誠実性ルール
ユーザーから詳細が提供されていない場合、内容を創作しないでください。次の明示的なプレースホルダーを記載します:
- 概要:
No summary provided. - 追加:
No additions provided - 修正:
No fixes provided - 破壊的変更:
None - 既知の問題:
None reported - アップグレードに関する注意:
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>
成果物の前に 1 文だけ記述します。</artifact> の後には何も記述しません。