How to ドキュメントを最新に保つ with Eigent

仕組み

1. ドキュメント化が必要な変更済みのソースファイル、ブランチ、プルリクエスト、またはコミットを共有します。
2. 影響を受ける機能名、設定キー、コマンド、例について、既存ドキュメントを検索するよう Eigent に依頼します。
3. 変更が必要なドキュメントだけを更新します。ページ構成、用語、相互リンク、frontmatter は維持してください。
4. フォーマットとドキュメントのチェックを実行し、各ユーザー向け主張の根拠を Eigent に要約させます。
5. 公開前に要約を確認し、内部情報や未公開情報が公開ドキュメントに漏れていないことを確認します。

試せる追加プロンプト

• この PR で変更された挙動を参照している既存のドキュメントページはどれですか？
• この変更は、更新が必要な公開 API パラメータ、デフォルト値、CLI フラグに影響しますか？
• 既存の形式に合わせて、このリリースの変更履歴エントリを作成してください。
• ソースコードだけでは確認できない、更新済みドキュメント内のユーザー向け主張を特定してください。

使い方

ドキュメント化したい変更から始めます。ブランチ、PR、またはコミットを共有してください。下書きを作成する前に、既存のドキュメントを検索するよう Eigent に依頼すると、新しい重複ページを作成するのではなく、適切なページを更新できます。範囲は狭く保ってください。ページ全体の書き換えより、正確な注記や例の更新のほうが適しています。これを再利用可能にするには、ワークフローをスキルとして保存するか、各リリース後に定期実行するよう Eigent に依頼してください。

期待される出力

ユーザー向けの変更のみを含む更新済みドキュメントファイル、変更内容と検証内容の要約、そして信頼できるソースで確認できず人間によるレビューが必要な主張の一覧。

制限事項

• 明示的に提供しない限り、Eigent は非公開の顧客データ、未公開のロードマップ項目、または内部 wiki にアクセスできません。
• ドキュメントの正確性は、ソースコメントとテストカバレッジの品質に依存します。文書化されていない挙動は見落とされる可能性があります。
• 非常に大規模なドキュメントサイトでは、サイト全体ではなく特定のセクションや機能領域に検索範囲を絞ると効果的です。