Codex use case
ドキュメントを常に最新に
コードなどの情報源を使って、ドキュメントの更新を自動化します。
Codex を使って、ソースコードの変更、公開ドキュメント、リリースノート、PR のコンテキストを突き合わせ、対象を絞ったドキュメント更新案を作成し、公開前の検証手順も用意します。
最適な用途
- 頻繁に変更される動作に追随する必要がある開発者向けドキュメント、README、ランブック、サンプル、移行ノート
- 技術製品のドキュメントを保守するチーム
Contents
ドキュメントを常に最新に
コードなどの情報源を使って、ドキュメントの更新を自動化します。
Codex を使って、ソースコードの変更、公開ドキュメント、リリースノート、PR のコンテキストを突き合わせ、対象を絞ったドキュメント更新案を作成し、公開前の検証手順も用意します。
Codex を使って、ソースコードの変更、公開ドキュメント、リリースノート、PR のコンテキストを突き合わせ、対象を絞ったドキュメント更新案を作成し、公開前の検証手順も用意します。
関連リンク
最適な用途
- 頻繁に変更される動作に追随する必要がある開発者向けドキュメント、README、ランブック、サンプル、移行ノート
- 技術製品のドキュメントを保守するチーム
スキルとプラグイン
- GitHub がバグ受付フローに含まれる場合は、イシュー、Pull Request、コメント、レビュースレッド、失敗したチェックを確認します。
| Skill | Why use it |
|---|---|
| GitHub | GitHub がバグ受付フローに含まれる場合は、イシュー、Pull Request、コメント、レビュースレッド、失敗したチェックを確認します。 |
開始用プロンプト
はじめに
ドキュメントは、ソース変更の数週間後ではなく、その変更と同時に更新すると、最新の状態を保ちやすくなります。Codex は、コードの変更、テスト、リリースノート、リンク先のイシュー、Pull Request のコンテキストを確認したうえで、既存の構成に沿って対象範囲を絞ったドキュメント更新案を作成できます。
開発者向けドキュメント、README の更新、変更履歴の下書き、移行ノート、ランブックなど、頻繁に変わる動作の反映が必要なあらゆるドキュメントに、このワークフローを使用できます。
使用方法
-
ドキュメント化が必要な変更から始めます。
対象のブランチ、Pull Request、コミット、イシュー、ファイルを共有します。公開ドキュメントの場合は、未公開のロードマップ、顧客の非公開情報、社内限定のコンテキストを含めないことを明示します。
-
影響を受けるドキュメントを洗い出すよう Codex に依頼します。
下書きを作成する前に、機能名、設定キー、コマンド、サンプル、関連用語を既存のドキュメントから検索させます。
-
有用性を損なわない最小限の範囲でドキュメントを更新します。
Codex には、現在のページ構成、用語、相互リンク、フロントマターを維持させます。対象を絞った注記、サンプル、セクションの更新だけで十分な場合は、大幅な書き直しを避けるようにします。
-
変更内容を検証します。
リポジトリに適した書式チェックとドキュメントチェックを実行し、ユーザー向けの各記述を裏付ける根拠を要約するよう Codex に依頼します。
Codex に提供する情報
| 情報源 | 役立つ理由 |
|---|---|
| 変更されたコードとテスト | Codex が実際の動作を分析し、必要箇所に絞ったドキュメント更新案を作成できるようにします。 |
| 公開されているリリースノートまたは製品ドキュメント | 公開されている用語、提供状況、機能のステータスに沿ったドキュメントを Codex が作成するのに役立ちます。 |
| Pull Request またはイシューのコンテキスト | 変更の理由と、ユーザー向けのどの動作が重要かを説明します。 |
| ローカルのドキュメントチェック | ドキュメントの公開前に満たすべき具体的な完了条件を Codex に示します。 |
公開リリースノートなど、より多くのコンテキストを追加すると、Codex は非公開のコンテキストや未公開の更新を含めずに済みます。
繰り返し使えるワークフロー
リポジトリ全体の規約として、ドキュメントに関する要件を AGENTS.md に追加します。例：
## Documentation
- When user-facing behavior changes, check whether docs, examples, or changelogs need updates.
- Public docs must only include public information or behavior visible in this repo.
- Preserve existing terminology and frontmatter.
- Run the docs formatting and build checks before final handoff.プロセスの手順がさらに多い場合は、今後の Codex タスクでも同じ情報源の確認、下書き、検証のサイクルに従えるよう、そのプロセスを スキル にします。このパターンの詳細については、ワークフローをスキルとして保存 を参照してください。
また、現在のチャットから、このワークフローのタスクをスケジュールする こともできます。たとえば、GitHub の最近の Pull Request を取得し、毎週ドキュメントを最新の状態に保つよう Codex に依頼します：
関連するユースケース
Codex が使える CLI の作成
どのフォルダーからでも実行でき、リポジトリスクリプトと組み合わせたり、ファイルをダウンロードしたりでき、付属スキルを通じて使い方を記憶できる、組み合わせ可能な CLI を Codex...
ブラウザゲームの作成
Codex を使って、ゲームの企画概要をまず明確なプランに落とし込み、次に実際に遊べるブラウザゲームを構築します。imagegen でビジュアルアセットを生成し、Codex...
ゴールに沿った作業
Codex が複数のターンにわたり、検証可能な停止条件に達するまで作業を続ける必要があるタスクには、`/goal` を使用します。