AIフレンドリーなGitHubリポジトリ内のドキュメントにするための調査

All GitHub

背景/概要

生成AIの活用がコード生成からドキュメンテーションに関する活用にも広がってきた。 一例としてCopilot knowledge basesがある。

Copilot以外にも似たサービスが増えているので、それらでも活用しやすいドキュメントを書くための要点を調査する。

なお、GitHubリポジトリと連携可能なサービスを調査対象にする。

ドキュメントを活用するサービス

Copilot knowledge bases

Managing Copilot knowledge bases

  • Markdownドキュメントからナレッジベースが作られる
  • ナレッジベースはCopilot Chatのコンテキストとして使われる
  • いくつかのリポジトリを選択してナレッジベースを作れる
  • ナレッジベースに含めたいパスを指定できる
  • ナレッジベースを削除することもできる