name: doc-rq-gl description: RQ-GL(用語集要求)文書を新規作成・改訂するときに、diopside規約準拠で作成・更新する metadata: short-description: RQ-GL 文書の更新ガイド
目的
- diopside(白雪 巴 公開YouTubeアーカイブ収集・蓄積・検索)の文書を、Obsidian運用規約に沿って更新する。
このスキルを使う条件
RQ-GL-*文書を新規作成・改訂し、用語定義や判定条件を追加・変更するとき。- 用語ID/英名(
term_en)/適用範囲の整合を取りながら、関連文書へのリンクを更新するとき。
このスキルを使わない条件
- 機能要求(
RQ-FR-*)や非機能要求の本文改訂が主目的のとき(対応するdoc-rq-*スキルを使う)。 - 用語定義を変えず、リンク検査や体裁確認だけを実施するとき(
obsidian-doc-checkを優先する)。
何を書くべきか
- 文書IDに対応する1トピックの内容。
- Frontmatter必須キー(id/title/term_en/doc_type/phase/version/status/owner/created/updated/up/related/tags)。
- 要求または設計の意図、受入条件、関連リンク。
## 変更履歴への当日追記。
何を書かないべきか
- 複数トピックの混在。
- 本文での上位/下位セクション(関係はfrontmatterのみ)。
- Mermaid以外の図表形式。
Frontmatter運用
phaseは ID prefix と一致させる。ownerはRQ-SH-*を使う。term_enは ASCII のsnake_caseで定義し、同義の英名を重複登録しない。- 意味変更時は
versionをPATCH更新する。 updatedは作業日へ更新する。
定義運用
## 定義の用語説明には英名を併記する(例:英名: \term_en``)。## 定義は表形式(用語ID/用語名/英名/定義/判定条件/適用範囲)を標準とする。- タクソノミ系用語(例:
タグ種別)は、別表としてタグ種別/説明/付与ルールを定義し、運用時の判定基準を明示する。 - プログラム実装では原則
term_enを識別子の基準語彙として参照する。
品質チェック
filename == idを維持する。up/relatedのリンク先が存在することを確認する。- 変更後に
python3 .opencode/skills/obsidian-doc-new/scripts/auto_link_glossary.py <対象Markdownパス>を実行し、用語(RQ-GL-*)をObsidianリンクへ自動変換する。 - 変更後に
python3 .opencode/skills/obsidian-doc-check/scripts/validate_vault.py --docs-root docs --report reports/doc_check.mdを実行しreports/doc_check.mdを更新する。
出力契約
- 出力は「更新した
RQ-GL-*文書(1トピック=1ファイル)」を中心とし、定義表とterm_enの整合を満たすこと。 - 意味変更がある場合は
version(PATCH)とupdatedを更新し、up/relatedで関連文書を辿れる状態にすること。 - 品質チェック実行後、必要な差分(文書本体と
reports/doc_check.md)のみを提示すること。