name: doc-rq-av description: doc-rq-av に対応するdiopsideの可用性要求(RQ-AV)文書を規約準拠で作成・更新し、受入閾値と関連文書整合を確認する。可用性要求(RQ-AV)文書の追加・変更・レビュー時に使う metadata: short-description: RQ-AV 文書の更新ガイド
目的
- diopside(白雪 巴 公開YouTubeアーカイブ収集・蓄積・検索)の文書を、Obsidian運用規約に沿って更新する。
何を書くべきか
- 文書IDに対応する1トピックの内容。
- Frontmatter必須キー(id/title/doc_type/phase/version/status/owner/created/updated/up/related/tags)。
- 要求または設計の意図、受入条件、関連リンク。
## 変更履歴への当日追記。
何を書かないべきか
- 複数トピックの混在。
- 本文での上位/下位セクション(関係はfrontmatterのみ)。
- Mermaid以外の図表形式。
Frontmatter運用
phaseは ID prefix と一致させる。ownerはRQ-SH-*を使う。- 意味変更時は
versionをPATCH更新する。 updatedは作業日へ更新する。
品質チェック
- NFR文書では SnowCard の
要求/受入基準/例外/エラーを「〜できる」基調で記述し、1項目1判定に分解する。 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を更新する。
使う条件
- 可用率・MTTR・計画停止時間など、可用性の受入閾値を伴う RQ-AV 文書を新規作成・更新・レビューするとき。
- 外部要因の切り分け条件や Go/No-Go 判定連携(
AT-GO/AT-RPT)を含め、可用性要求の整合を確認したいとき。
使わない条件
- 機能要求(FR)や、可用性以外の非機能要求(例: セキュリティ/性能)だけを扱うとき。
- 実装コードのみを変更し、
docs/**の RQ-AV 文書を更新しないとき。
出力契約
- 更新対象の RQ-AV 文書で、可用性指標・受入基準・例外条件・依存リンクが規約に沿っていること。
- 変更理由の要約と、実施した整合チェック(リンク/検証スクリプト)の結果。