name: doc-rq-uc description: doc-rq-uc に対応するユースケース要求(RQ-UC)文書を、追加・変更・レビュー時に規約準拠で作成・更新する metadata: short-description: RQ-UC 文書の更新ガイド
目的
- diopside(白雪 巴 公開YouTubeアーカイブ収集・蓄積・検索)の文書を、Obsidian運用規約に沿って更新する。
このスキルを使う条件
docs/1.要求(RQ)/31.ユースケース(UC)配下の文書を新規作成・改訂する。概要/基本フロー/代替・例外フローのうち、ユースケース固有の振る舞いを追加・変更する。- ユースケース要求の意味変更があり、関連文書とのトレーサビリティ確認が必要になる。
このスキルを使わない条件
- FR/NFRや設計文書(BD/DD)を更新するだけで、RQ-UCを変更しない。
- 文言修正のみで、ユースケースの振る舞い・受入条件・例外条件に変更がない。
出力契約
- 対象
RQ-UC-*文書が、必須Frontmatterと概要/基本フロー/代替・例外フローを満たした状態で更新されている。 up/relatedが有効なObsidianリンクになっており、関連要求との追跡経路が維持されている。- 用語リンク補正と
validate_vault.py実行後、検証結果がreports/doc_check.mdに反映されている。
何を書くべきか
- 文書IDに対応する1トピックの内容。
- Frontmatter必須キー(id/title/doc_type/phase/version/status/owner/created/updated/up/related/tags)。
- 要求または設計の意図、受入条件、関連リンク。
概要/基本フロー/代替・例外フローをユースケース固有の内容で記述する。- 主体はアクター目的主体(
[[RQ-SH-*|...]]が〜する)で記述し、システムは主体の表現を使わない。 ## 変更履歴への当日追記。
何を書かないべきか
- 複数トピックの混在。
- 本文での上位/下位セクション(関係はfrontmatterのみ)。
- Mermaid以外の図表形式。
Frontmatter運用
phaseは ID prefix と一致させる。ownerはRQ-SH-*を使う。- 意味変更時は
versionをPATCH更新する。 updatedは作業日へ更新する。
品質チェック
filename == idを維持する。up/relatedのリンク先が存在することを確認する。基本フローがテンプレート文(例: 「操作を開始する」「入力を検証し、処理を実行する」)のまま残っていない。代替/例外フローがユースケース固有の例外を2件以上持つ。- 本文がアクター目的主体で記述され、
システムは主体へ回帰していないことを確認する。 - 変更後に
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を更新する。