intelligence-vocabulary について
intelligence-vocabularyは、CopilotKit Intelligenceの顧客向け文章を作成するスキルです。用語を統一し、顧客向け文言とコード識別子を区別します。
主な機能
- 01顧客向け文章の用語を統一
- 02禁止表現を検索して置換
- 03コード識別子とスラッグを維持
- 04新規ページは文書スキルと連携
- 05Inspectorの手順に表示ラベルを使用
活用シーン
- 01Intelligence文書の編集
- 02ナビゲーションやボタンラベルの確認
- 03Intelligenceページの追加や改名
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ copilotkit/ copilotkit --skill intelligence-vocabularyインストール後、Claude Code で/intelligence-vocabularyを入力して読み込まれたか確認します。
同梱ファイルreferences/words.md
詳細
インテリジェンス用語
お客様向けのインテリジェンス関連ドキュメントでは、概念ごとに名前を1つだけ使用します。同じものに別の名前を付けるのは後退です。
使用する場面
お客様が読む CopilotKit Intelligence に関する文章を作成または編集する前に、このスキルを読み込んでください。これには、showcase/shell-docs 配下のページ、スニペット、ナビゲーションタイトル、ボタンラベル、画像の代替テキストが含まれます。
インテリジェンス関連のページを追加、名称変更、削除する場合は、skills/intelligence-docs/SKILL.md も読み込んでください。このスキルはランディングページを同期した状態に保ちます。このスキルは用語を扱います。
コードの名称変更には、このスキルを読み込まないでください。識別子、ルートスラッグ、環境変数、API フィールド、コンポーネント名は、Stop ワードが含まれていても、そのままにしてください。
手順
手順 1:用語リストを適用する
- お客様向けのインテリジェンス関連の文章を作成または編集する前に、
references/words.mdを読んでください。 - 見出し、ナビゲーションタイトル、ボタンラベル、代替テキスト、本文では、Use 列の用語を使用してください。
- プラン名は Developer、Team、Team Self-hosted、Enterprise のままにしてください。
- ある事実がすでに
references/words.mdに記載されている場合は、そのページにリンクしてください。別の名前で同じ事実を再度説明しないでください。 - Inspector のクリック手順では、リリース済みのコントロールに表示されるラベル Rich Threads と Automatic Learning を使用してください。
手順 2:変更を確認する
- 追加または編集した文章を検索し、
references/words.mdの Stop 列にあるすべての語句がないか確認してください。 references/words.mdの例外リストに記載されている一致は、そのままにしてください。- それ以外の一致はすべて、その概念に対応する Use の用語に書き換えてください。
- 識別子、スラッグ、環境変数、API フィールド、コンポーネント名は変更しないでください。
判断フロー
- お客様向けのインテリジェンス関連の文章、ラベル、代替テキスト:手順 1 を実施し、その後、手順 2 を実施します
- ページを追加、名称変更、削除する場合:用語についてはこのスキルを、ランディングページについては
skills/intelligence-docs/SKILL.mdを使用します - 編集内容がコード、スラッグ、環境変数、API フィールドのみの場合:停止してください。用語リストに合わせて名称を変更しないでください
- ページがインテリジェンスについて言及していない場合:停止してください
注意すべき兆候
| 兆候 | 意味 | 対応 |
|---|---|---|
| 同じページで1つの概念に2つの名前が使われている | 用語リストを参照していません | 手順 2 を実施します |
| CopilotKit が運用するデプロイメントの名称として「managed」または「hosted」を使用している | デプロイメント名が揺れています | cloud-hosted と記載します |
| コンポーネント、スラッグ、環境変数の名称変更によって Stop ワードが削除されている | このスキルをコードに適用しています | 識別子を元に戻します。変更するのはお客様向けの文章のみです |
| Clerk またはロールアウトのしきい値が、お客様向けページに追加されている | 内部実装が漏れています | その文を削除します。お客様が行うことを記載してください |
エラーへの対処
- Stop の語句が識別子に含まれている場合: 識別子はそのままにしてください。周囲の文章で Stop ワードをお客様向けの名称として使っている場合に限り、その文章を変更してください。
- 一致した語句が例外リストにある場合: そのままにしてください。managed Channel、customer-managed、hosted zone、チケット ID、プラン名を「修正」しないでください。
- 承認済みの用語と画面上の商品ラベルが異なる場合: クリック手順では、リリース済みのコントロールに表示されるラベルを使用してください。矛盾を記録してください。第3の名称を作らないでください。
- 新しい事実の記載先がない場合: 停止して、必要なページが存在しないことを伝えてください。近接するページに新しい類義語を使って事実を記載しないでください。
コメント
Markdown 対応