サイトの構成

このサイトの構成

このサイトは自分なりに、 ナビゲーションしやすさを考えて作っています。 以下のような構造になっています。

RSS/Atomフィード

なぜこのような形式にしたのか

例えば、「WindowsでSHA-256ハッシュを取る方法」を例に取ります4。 このときにいちばん重要なのは、「SHA-256」という単語です。 よって、「SHA-256」というページ(マニュアル)を作って、 そこに「Windowsでの取得方法」を書くようにしています。

また、そもそも「SHA-256」とは何かの説明が必要です。 しかし、SHA-256の取得方法と混ぜると、ページがごちゃごちゃしてきます。 よって、同様に「SHA-256」というページ(辞書)を作って、 そもそもSHA-256とは何かを説明するようにしています5

この「辞書」と「マニュアル」が基本です。 「マニュアル」から初回のみの手順を分離したものが「設定手順書」、 分量が大きいもの、めったに使わないものを分離したのが「逆引きマニュアル」です。 「逆引きマニュアル」は必ずタグを付けるようにして、 「辞書」や「マニュアル」からたどりやすくしています6

書きやすい

この構成はちょっと変わってますが、自分としてはものすごく書きやすいです。 その理由をいくつか書きます。

  1. タイトルを考えなくてよい
    • タイトルは全て「単語そのもの」です。「マニュアル」とか「辞書」とかは、Hugoのテーマ機能でつけてます。
    • SEOには不利かと思いますが、タイトルに悩まなくて済むのは時間の節約になります。
  2. 何が足りないかが分かる
    • gameタグがあるときに、gameの記事が必要だと分かります。
    • ansibleのマニュアルがあるときに、ansibleの記事(dic)が必要だと分かります。
    • これらのチェックをスクリプトにしている
  3. 定型化している
    • 辞書は必ず〜〜とはからは始まっています。
    • 逆引きマニュアルはやりたいこと, 前提条件, 手順の3つを含めるようにしています。
    • 公式サイト、外部リンクなどはYAML Front MatterでURLとタイトルを貼るだけで、いい感じにしてくれます。
  4. 分割しやすい
    • サブセクション機能を使うことにより、分割しやすくなっています。
    • サブセクションは見通しが悪く、ビルドに時間もかかるので廃止予定です。
  5. ランダムボタンがある
    • たまに自分で押して、レビューに使用しています。

その他のセクション候補

このサイトでは使っていませんが、他で使っているセクションや用語を書いておきます。

影響を受けたもの


  1. 一般的なブログに近いのはここです。 [return]
  2. スクリプトなどを含みます。 [return]
  3. 引用をまとめる意味がなさそうなので、辞書に統合しました。 [return]
  4. 専門的で分かりにくい人もいると思いますが。 [return]
  5. まだそのページは作ってないですが。 [return]
  6. 最低2クリック必要なのでまだ分かりづらいですが。 [return]

ページトップへ戻る