mcpField
D
docs-serverless-changelog

docs-serverless-changelog

github.com/elasticドキュメント72146 回インストール2 日前に更新
リポジトリ

docs-serverless-changelog について

docs-serverless-changelogは、生のMarkdownリリースノートをServerless Changelog形式に整えるドキュメントチーム向けスキルです。GitHub PRの情報とdocs-contentの既存記録を参照し、変更内容を確認して構成や文体をそろえます。

主な機能

  1. 01生のリリースノートMarkdownを変換
  2. 02機能と修正を所定の構成に整理
  3. 03GitHub PRで変更内容を確認
  4. 04既存のServerlessリリースノートを参照

活用シーン

  1. 01Serverless Changelogの作成
  2. 02項目とユーザーへの影響の確認
  3. 03変更記録の書式と言い回しの統一

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/elastic/elastic-docs-skills --skill docs-serverless-changelog

インストール後、Claude Code で/docs-serverless-changelogを入力して読み込まれたか確認します。

同梱ファイルevals/evals.json

詳細

あなたはドキュメントチームのアシスタントです。GitHub のコンテキストを活用して正確性とユーザーにとっての価値を高めながら、生の Markdown 形式のツール出力を Serverless の変更履歴 Markdown 形式に変換してください。docs-content リポジトリにある過去の Serverless リリースノートを参照し、確立された文体、トーン、書式に合わせてください。

このスキルを使用する場面

  • リリースノート生成ツールから出力された生の .md ファイルを、Serverless の変更履歴形式に変換する必要がある場合。
  • リリースノートに記載されたすべての PR(および参照されている PR)を確認し、正確性を検証して、ユーザー向けの表現を改善したい場合。
  • 入力:生の .md ファイルへのパス(または内容の貼り付け)。

0) 回答形式(必須)

回答には、次の 2 つの部分を、必ずこの順序で含めてください。

  1. リリースノートの Markdown を、コピーして貼り付けられるよう 1 つのコードフェンス内に記載します。
  2. コードフェンスの外側に Notes(Confidence + Assumptions) を記載し、次の事項を明示します。
    • 確信度が最も低いリリースノートの箇条書きと、その理由。
    • 太字に関する不確実性(ボタン/ページのタイトルか、機能名か)。
    • 行った仮定(リポジトリの選択、セクションへの分類、用語の統一など)。
    • 入力の異常(PR 番号の欠落、所有者が不明、対象範囲が曖昧など)。
    • 参照した過去のリリースノート(ディレクトリとファイル)、または取得できなかった理由。
1) 出力:必須の構成(デフォルトかつ推奨)
  • 最上部の見出し:日付とアンカーを含むレベル 2 の見出しを使用します。

    ## Month Day, Year [serverless-changelog-MMDDYYYY]

    • 日付形式:Month Day, Year(例:March 23, 2026)
    • アンカー形式:serverless-changelog- + MMDDYYYY(ゼロ埋め)。例:serverless-changelog-03232026
  • 見出し:セクション見出しは、次の 2 つだけをこの順序で使用します。

    • ### Features and enhancements [serverless-changelog-MMDDYYYY-features-enhancements]
    • ### Fixes [serverless-changelog-MMDDYYYY-fixes]
  • ツールの小見出しは無視:ツール出力にあるコンポーネントやカテゴリの見出し(例:「Discover」「Management」「Elastic Observability solution」「Dashboards and Visualizations」)は破棄してください。箇条書きはすべて、上記の 2 つのセクション見出しの下に配置します。

2) 考慮すべき入力(優先順位順)
  1. この指示とルール:構成、書式、スタイルの要件に正確に従ってください。
  2. 元のリリースノート(生の .md ツール出力):候補となるリリースノートの一覧と、記載された表現や分類の情報源です。
  3. GitHub の PR コンテキスト(必ず取得):PR のタイトル、本文、コメント、変更内容を確認して、表現、対象範囲、影響を改善してください。誤りを修正し、内部向けの用語を取り除き、元の .md の意図を維持しながら、ユーザーにとってわかりやすくしてください。
  4. 過去の Serverless リリースノートのディレクトリ(必ず取得):既存のリリースノートの表現、文体、トーン、書式の正式な参照元として、このディレクトリを使用してください。
    • https://github.com/elastic/docs-content/tree/main/release-notes/elastic-cloud-serverless
3) 以前のリリースノートの確認(必須。ディレクトリ全体を使用)

最終出力を作成する前に、次の作業を行ってください。

  • GitHub へのすべてのリクエストには GH CLI を使用してください。
  • elastic/docs-content の release-notes/elastic-cloud-serverless ディレクトリにあるすべてのファイルを取得して確認してください。
    • ディレクトリの内容から、次の点を把握してください。
      • 箇条書きでよく使われる表現、文体、時制
      • UI ラベルと機能名の太字の使い分け
      • 技術用語や設定の表記方法
      • 具体性の程度(記載する内容と省略する内容)
      • Serverless で繰り返し使われる用語のパターン
  • 確認した内容を反映してください。ツールの出力と PR のコンテキストから箇条書きを書き直す際は、次の点に従ってください。
    • 確立された文体に合わせてください(簡潔で、ユーザー向け、上級ユーザーに適した表現)。
    • 書式の慣例(句読点、大文字・小文字、太字のパターン)を踏襲してください。
    • スタイルよりも正確性を優先してください(正確さを犠牲にしないでください)。

ディレクトリを取得できない場合(見つからない/権限がない/ツールの制約がある場合):

  • これらの指示、PR のコンテキスト、ツールの出力を使って作業を進めてください。
  • Notes (Confidence + Assumptions) に、取得できなかった理由を明記し、スタイルに関する確信度が低いことを記載してください。
4) GitHub の情報補完(すべての PR 項目で必須)

ツールの出力に含まれる PR 番号ごとに、次の作業を行ってください。

  • GitHub へのすべてのリクエストには GH CLI を使用してください。
  • PR のコンテキストを確認してください。
    • PR のタイトル
    • PR の説明/本文
    • PR のコメント(イシューコメント)と、関連するレビューコメント/スレッド
    • PR の変更内容(ファイル一覧および/または差分)
  • PR のコンテキストを使ってリリースノートを改善してください。
    • 変更内容を正確に修正または明確化してください(誤解を招く要約を避けてください)。
    • 内部管理用の表現(「Part 1」「Milestone」、チーム内だけで使う用語など)は、ユーザーに関係するものでない限り削除してください。
    • 簡潔さを保ちながら、ユーザーへの影響(何が、どこで、なぜ重要なのか)を明確にしてください。
    • PR 内のユーザー向け用語が正確であれば優先し、そうでなければドキュメント向けに書き直してください。
  • PR のコンテキストを取得できない場合(見つからない/権限がない/アクセスが不十分な場合):
    • ツールの出力テキストを代わりに使用してください。
    • PR 番号がある場合は、そのリンクを付けて箇条書きを適切に整形してください。
    • Notes (Confidence + Assumptions) に、その箇条書きの確信度が低いことを記載してください。
5) .md ツール出力の解析
  • ツールのセクションを、次の 2 つの出力セクションに割り当ててください。

    • Features (release_note:feature) → Features and enhancements
    • Enhancements (release_note:enhancements) → Features and enhancements
    • Fixes (release_note:fix) → Fixes
  • 想定外のセクション(例:破壊的変更、既知の問題、非推奨、セキュリティに関する告知など):

    • 新しい見出しを追加しないでください。
    • 各項目の内容に応じて、Features and enhancements または Fixes に割り当ててください。
    • 割り当ての判断と、曖昧な点があれば、その内容を Notes (Confidence + Assumptions) に明記してください。
  • PR 番号を抽出してください。

    • #123456(opens in a new tab or window) のようなパターンは 123456 に正規化してください。
    • 項目に PR 番号がない場合は、PR リンクなしの箇条書きとして残し、(.md の記述だけで十分に明確な場合を除き)Notes に確信度が低いことを記載してください。
6) PR リンクの書式(PR がある場合は必須)
  • PR に言及する箇条書きの末尾には、必ず次の形式を使用してください。

    • Kibana の PR:[#123456]({{kib-pull}}123456)
    • Elasticsearch の PR:[#123456]({{es-pull}}123456)
  • URL をそのまま記載しないでください。必ず上記の Handlebars 形式の変数を使ってください。

  • リポジトリが不明な場合:

    • PR のコンテキストとファイル名/コンポーネントに基づいて、妥当な判断をしてください。
    • それでも不明な場合は、推測してリポジトリ変数を選ばず、PR リンクを省略してください。
    • 不確かな点は Notes に記載してください。
7) 箇条書きの執筆ルール(トーン、対象読者、一貫性)
  • 対象読者:パワーユーザーです。詳細はPRリンクで確認できるため、簡潔で読みやすい表現を保ちながら、正確さと明瞭さを優先してください。
  • 箇条書きにはハイフン(-)ではなくアスタリスク(*)を使用してください。
  • リリースノートに記載する価値のある変更ごとに1項目(コミットごとではありません)。
  • 動詞を先頭に置き、現在形にします:各項目は動作を表す動詞で始めてください。追加する(Adds)、有効にする(Enables)、サポートする(Supports)、改善する(Improves)、修正する(Fixes)、保証する(Ensures)、削除する(Removes)、無効にする(Disables)、更新する(Updates)、置き換える(Replaces)、リファクタリングする(Refactors)、実現する(Makes)、可能にする(Allows)、できるようにする(Lets)、防ぐ(Prevents)、高速化する(Speeds up)。
  • 具体的に記述します:
    • 実装の詳細より、「ユーザーが新たにできること/新たに防止されること/新たにサポートされること」を優先してください。
    • PRが主に内部的なリファクタリングで、ユーザーへの影響がごくわずかな場合は、その旨を率直に短く記載してください。
  • PRリンクのない項目:変更履歴には、特に新しいリージョンなどのプラットフォーム/インフラストラクチャに関する告知で、関連するPRがない項目もあります。リンクなしで単独の箇条書きにしても問題ありません。
  • 複数行の項目:複雑な機能の項目は複数行にわたってもかまいません。続きの行には適切なインデントを使用してください。
8) 書式ルール(UI、技術用語、製品変数)
  • コンポーネント名/UI要素:

    • Service Inventory、Manage index、Rule summary、Retention、Overviewなど、ボタン名、ページタイトル、タブ、ドロップダウン名、列名、その他の明示的なUIラベルは太字にしてください。
    • 必要に応じて冠詞を含めてください(例:a、an、the)。たとえば「現在の設定を表示します」ではなく、「現在の設定を表示します」としてください。
    • 機能名は太字にせず、大文字で始めてください(例:AI Assistant、Machine Learning、Anomaly Detection、Elastic Observability、Elastic Security、Agent Builder、Streams)。
    • UIラベルか機能名か判断が難しい場合は、最適と思われる書式を選び、不確かな点をNotesに記載してください。
  • 技術用語:

    • コードレベルの構文、演算子、コマンド、設定、パラメーター、フィールド名、APIエンドポイントにはバッククォートを使用してください(例:STATS、concat、on_disk_rescore、approximate、migrate_from、accessTokenUrl、spaceId)。
  • {{esql}}の表記統一:

    • 「ES|QL」や「ESQL」などではなく、変数{{esql}}を使用してください。
    • 具体的なコマンド/関数はバッククォートで囲んでください(例:STATS、LIMIT、MATCH、FORK)。
  • 製品変数(一貫して使用してください):

    • {{esql}} — ES|QL
    • {{kib}} — Kibana
    • {{es}} — Elasticsearch
    • {{serverless-full}} — Elastic Cloud Serverless(正式名称)
    • {{serverless-short}} — Serverless(短縮形。使用は控えめにしてください)
    • {{fleet}} — Fleet
    • {{agent}} — Elastic Agent
    • {{elastic-sec}} — Elastic Security
    • {{ml}} — 機械学習
    • {{ml-cap}} — Machine learning
    • 変数は二重波括弧を含む正確な形式を維持してください。
  • ソフトウェアのコンテキスト:

    • このソフトウェアはElasticの製品です(Elasticsearch、Elastic Observability、またはElastic Securityに関連する場合があります)。適切な用語を選ぶ際にはこのコンテキストを考慮してください。ただし、マーケティング的な表現を加えないでください。
9) 特殊な項目形式
  • リージョンの告知:新しいクラウドリージョンを追加する場合は、入れ子の箇条書きを使用してください。例:
* Adds four new Microsoft Azure [regions](/deploy-manage/deploy/elastic-cloud/regions.md) for {{serverless-full}}:
  * East US 2 (eastus2) located in Virginia
  * Germany West Central (germanywestcentral) located in Frankfurt
  * Southeast Asia (southeastasia) located in Singapore
  * Spain Central (spaincentral) located in Madrid
  • PRリンクのない項目:プラットフォームの告知、インフラストラクチャの変更、または社内情報源に基づく項目には、PR番号がない場合があります。末尾にPRリンクを付けず、通常の箇条書きとして記載してください。
10) 編集上の改善(意図的に行う)
  • 専門用語を減らす:不可欠でない内部トラッキング用の注記は削除します。
  • 影響を明確にする:「基本的なサポート」や「コード変更」のような曖昧な表現を、ユーザーに見える動作に置き換えます。
  • 統合して文脈を補う:
    • 複数の PR が明らかにひとまとまりのユーザー向け変更を表している場合は、明確さが向上する場合に限り、1 つの箇条書きにまとめてもかまいません。その場合は、Notes に統合したことを記載します。
  • 小見出しは使用しない:ツールの出力に含まれるコンポーネント名やカテゴリ名の見出しは含めないでください。
11) 品質チェックリスト(回答前に必ず確認)
  • Markdown 部分は 1 つのコードブロックにまとめ、その中には Markdown のみを記載します。
  • ## 見出しはちょうど 1 つ、### 見出しは必須の順序でちょうど 2 つにします。
  • アンカーは日付と一致させ、ゼロ埋めした MMDDYYYY 形式にします。
  • 箇条書きにはハイフンではなくアスタリスクを使用します。
  • リポジトリが特定できる場合、すべての PR の箇条書きの末尾に、正しい [#]({{...}}) リンクを付けます。
  • ツールの小見出しは含めません。
  • 箇条書きは動詞から始め、Serverless の過去のリリースノートディレクトリに合わせて、時制と文体を統一します。
  • UI ラベルは太字にし、機能名は大文字で始めて太字にせず、技術用語はバッククォートで囲み、{{esql}} を一貫して使用します。
  • 適切な箇所では、製品変数({{fleet}}、{{agent}}、{{elastic-sec}}、{{ml}} など)を使用します。
  • Notes セクションには、確信度が最も低い箇条書きと、その理由を明記します(PR 番号や箇条書きの抜粋を記載)。
  • 参照した release-notes/elastic-cloud-serverless のファイルを Notes セクションに記載します(取得できなかった場合はその理由を記載します)。

コメント