🎓

Check! GitHub Docsで効率よく情報を探す

2023/12/01に公開

Prologue

こんにちは、@dz_ こと、岩永かづみです。

この記事はCode Polaris Advent Calendar 2023の2日目の記事です。

開発でお世話になっている方も多いGitHub。公式ドキュメント GitHub Docsを見ることはありますか？目的の情報探せてますか…？

私がGitHub Docsで情報を探すとき気にかけるポイントをご紹介します。

まず、GitHub Docsには「バージョン」があります。バージョンというとわかりにくいですが、どの製品に対するドキュメントかを選択できるものです。

GitHub Docsのバージョン切替え

通常、一般の開発者の立場でGitHubを利用する場合は、「Free, Pro, & Team」を選択しドキュメントを参照するとよいです。GitHub Enterprise CloudやGitHub Enterprise Serverに特化した情報が必要であれば、切替えて参照します。

混乱する場面としては、GoogleやBingなどの検索サイトやほかのサイトからリンクを開いたとき、このバージョンが目的と異なる場合があります。バージョンを確認してから参照するようにしましょう。

言語を切り替えられます。メジャーなページは日本語がしっかり用意されているので、基本は日本語を選択していても問題ないと思います。

GitHub Docsの言語切替え

ただし、本拠地が海外にあるサービスでよくあることですが、翻訳が遅れていたり不備がある場合もあります。英語に切替えて確認する癖をつけると、情報の精度が上がるでしょう。

ドキュメントの構成を知っていれば、素早く情報にアクセスできます。GitHub Docsのトップページには、各機能へのリンクが表示されています。

GitHub Docsトップページ

各機能のページでは、左側にさらに細かなメニュー階層があり、構成を眺めて把握しておくと情報を探しやすくなります。

GitHub Docs機能ページ

スクリーンサイズが小さい場合、左上のハンバーガーボタン（三本線のアイコン）からメニューを表示できます。

GitHub Docs機能ページ（スクリーンサイズが小さい場合）

GitHub Docs機能ページのメニュー（スクリーンサイズが小さい場合）

情報の在処が見当つかない場合は検索機能を使いますね。日本語でも検索できますが、英語で検索した方が目的の情報にたどり着けるかもしれません。

たとえば、Audit logすなわち監査ログについて検索したいとします。このとき、言語設定を日本語で検索すると、"audit"と"監査"でヒットするページが異なります。

"audit"で検索した場合の結果

"監査"で検索した場合の結果

このように、日本語訳に揺れがあったり、日本語で訳されていない場合には、日本語で検索してもヒットしません。不便ですが、英語で検索する方が二度手間を防げるでしょう。

もしかしたら、GitHub Universeで発表されたCopilot Chat in GitHub.com（GitHub Enterpriseライセンスのもと利用できる予定）が利用できるようになれば、この苦労はなくなるかもしれませんね。

サービスのドキュメントは癖があるものも多いですよね。UIや情報の構成を把握していれば、素早く情報にアクセスできます。ぜひ、GitHub Docsを活用してみてください。