はじめに
「自分で書く技術記事には、積極的にGitHubのリンクを載せていこう」と考えるに至った理由を書いた。
（便宜上GitHubと書いているが、BitbucketやGitLabなどでも 
）
理由その1: 公式Docsのリンクは、GitHubリポジトリに比べて変更される可能性が高い
例えば、Goのwebフレームワーク https://github.com/beego/beego は、過去に公式DocsのURLが beego.me から beego.vip に変更されていた。
→変更が反映されたPR: https://github.com/beego/beego/pull/4959
また、2024年8月時点では .vip へのリンクも切れている模様。
→ unavailable と追記されたPR https://github.com/beego/beego/pull/5628
さらに、（筆者の記憶上かつ2024年8月時点では確認できないため、話半分として読み流してほしいが、）2022年8月時点では .me ドメイン上には全く関係ないサイトが展開されていた……
理由その2: GitHubリポジトリを探す読者の手間を削減してあげる親切心
技術ブログに登場したライブラリの実装が気になってGitHubリポジトリを探しにいく、といった読者は一定数いるだろう。
分かりやすい箇所にGitHubリポジトリへのリンクが貼られている公式Docsであれば、
「技術ブログ内のリンク→公式Docs内のリンク→GitHubリポジトリ」
の移動がスムーズなので、読者はそこまで負担を感じないだろう。
しかし、webサイトのレイアウトはどうしても各々で異なるため、また人によって見やすさが異なるため、公式Docsによってはリンクを見つけることに苦戦してしまう。
そういった負担を和らげるためにも、GitHubリポジトリへのリンクが貼られていると嬉しい。
とはいえ、
- 実装よりも概要が気になるので、公式Docsに初手で辿り着きたい読者もいる
- GitHubリポジトリ上から公式Docsのリンクが見つけられないパターンもある
- 読者が自分自身でググれ
といった考え方もあるので、この理由はそこまで本記事の主張を支持するようなものではないか……
おわりに
筆者自身、最近意識し始めたばかりなので過去記事は対応できておらず心苦しい……
ちなみに、読み手として、
実装よりも概要が気になるので、公式Docsに初手で辿り着きたい
この感情を抱くことも多いので、公式DocsとGitHubリポジトリ両方のリンクを載せるという案もありか。
（把握してないだけで、GitHubリポジトリが変更になる事例も実はたくさんあるかもしれないし）