外部調査時の docs / references / latest manifest 更新手順を固定化する。research-to-docs の runbook。
このスキルは、外部調査の結果を Oh-MY-TradingView のドキュメント体系に正しく残すための手順書である。 調査結果を一時的なメモに留めず、durable asset として固定化する。
docs/references/design-ref-llms.md への参照記録が必要なときdocs/research/latest/ に調査結果を追加するとき調査で参照した全ての外部資料を docs/references/design-ref-llms.md に追記する。
テンプレート:
## 番号:名前
- URL: ***
- 参考にした理由: ***
- このプロジェクトにどう活かしたか: ***
- 採用したもの: ***
- 採用しなかったもの: ***
ルール:
比較調査や深い分析の結果は docs/research/latest/ にマークダウンで作成する。
命名規則: <topic>-<description>.md(例: external-agent-pattern-comparison.md)
必須セクション:
docs/research/latest/manifest.json の keep 配列に新規ドキュメントを追加する。
{
"keep": [
"README.md",
"...",
"新しいドキュメント名.md"
]
}
docs/research/latest/README.md の「読む順番」セクションに新規ドキュメントを適切な位置に挿入する。
node --test tests/repo-layout.test.js tests/archive-latest-policy.test.js
manifest に記載したファイルが実際に存在すること、latest の運用ルールに反していないことを確認する。
docs/
├── references/
│ └── design-ref-llms.md ← 参照台帳(Step 1)
├── research/
│ ├── latest/
│ │ ├── README.md ← 読む順番(Step 4)
│ │ ├── manifest.json ← keep-set(Step 3)
│ │ └── *.md ← 調査結果(Step 2)
│ └── archive/ ← stale docs の移動先
└── exec-plans/
├── active/ ← 実施中の計画
└── completed/ ← 完了した計画
| Anti-Pattern | 正しいアプローチ |
|---|---|
| 参照台帳を更新せずに実装を進める | 外部資料を参照したら 必ず design-ref-llms.md に記録してから実装する |
| manifest.json を更新せずに latest にファイルを追加する | ファイル追加と manifest 更新は 同時に 行う |
| 調査結果を session log だけに残す | 有用な知見は docs/research/latest/ に durable doc として固定する |
| 「採用しなかったもの」を省略する | 不採用理由は将来の再検討時に重要。必ず明記する |
| latest に古い世代のドキュメントを放置する | scripts/docs/archive-stale-latest.mjs で manifest 外を archive に移す |