Secret Ninja Blog

Support Engineering Manager してます

Zendesk Guideのリンク切れをGoogle Search Consoleで表示させる

ドキュメントをメンテする上で、ページのリンク切れをなくすのはコンテンツのクオリティを担保する上で重要です。

f:id:toru-takahashi:20180315142611p:plain

しかし、Zendesk Guideには、リンク切れをチェックする機能がないため、なんらかのツールを使ってZendesk Guideのコンテンツを調べ、リンク切れを調査する必要があります。 そこで、Google Search ConsoleのCrawlerエラーを使うことでリンク切れを検出し、定期的に閲覧・修正が容易にできるようにしたいと思います。

ちなみに、 Google Search Consoleは、Google 検索結果でサイトのパフォーマンスを監視、管理ができるサービスです。 そのオプション的な機能として、Crawlerのサイトチェックによってリンク切れの調査を行うことができます。 このGoogle Search ConsoleにZendesk Guideを登録することで、Zendesk GuideのGoogle検索の流入キーワードを調べるだけでなく、リンク切れの調査などもすることができます。

Google Search Consoleに登録する

  1. Search Console - Homeにアクセス
  2. Add a propertyをクリック
  3. Zendesk GuideのHelp Centerを設定

https://treasure-data.gyazo.com/ceae3eebef691d9a62ff7173ffa47233

これだけで、Google Search Consoleの設定が完了します。

リンク切れのチェック

Google Search Consoleへの登録後、1~2日待っていれば、GoogleのCrawlerが自動で設定したサイト上を徘徊して、サマリーを表示してくれるようになります。

https://t.gyazo.com/teams/treasure-data/fe0f6333e3a77485c5223f7a411fe1cb.png

サイトのサマリーが表示される様になったら、Crawl > Crawl Errorを見てみます。 すると、Zendesk Guide内の記事でNot Foundになってしまっているリンクを表示してくれます。

https://t.gyazo.com/teams/treasure-data/2f2e63fb733c3318bbfb4e12c968f43f.png

また、そのリンク切れページがどこからLinkされているかも表示してくれます。

https://t.gyazo.com/teams/treasure-data/dabfa4385b484b770a8c49fc8937defd.png

あとはリンク先のGuideにアクセスしリンク記事を修正した後に"Mark as fixed"をクリックすることで、リンク切れの解消を報告することができます。

Google Search Consoleを利用することで、Google検索の流入キーワードを調べられるだけでなく、リンク切れの検索できるので登録しないわけにはいかないですね。

そのうち、Google Spreadsheetと連携して、新しいリンク切れを見つけたらslack通知するとかをできるようになると便利だなあと思うので、そのうちやってみたいですね。