Hejdaの見る夢

一人前のエンジニアを目指して頑張ったこととかをつらつら書くブログ

ナレッジのオープン化を始めました 🍜

リンク

https://gitlab.com/iganari/hkms

内容

  • 主にLinuxにて使用するコマンドの基本操作とよく使うオプションの説明
    • アプリケーションも同様

経緯

動機

普段よく使うコマンドって基本的には手が覚えているのでササッと書いてしまうのですが、例えばオプションの細かいところまでは把握してない場合も少なく無いと思います

必要になって、新しいコマンドやオプションを都度ググっていると非効率的だし、出てきた内容が古い情報だったり、自分の要件と合わなかったりすることも少なくありません

また、コマンドによって参考にするWebサイトが違うと情報の精度にばらつきが発生します

インフラエンジニアなので、コマンドによって精度に大きなばらつきがあると信用問題に繋がるのでそれは困ります(コマンドとオプションくらいすべて覚えておけよってのは無しです)

そうすると、だいたい手元で LANG=C man hogehoge を叩くところから始め、結果として大量のメモが自分のローカルに溜まっていきます

これはもったいないのでこのナレッジをオープンな場にアウトプットしておくことで、知識の共有やひらめきに繋がるのでは無いかと思いました

オープンにするに当たって考慮したこと

当初はレイアウトとか検索性能とかを追求したくて、いろんなフレームワークを試してみました

しかし、最終的には以下のような気付きがありました

  • ナレッジシステムにそこまでデザインは求めていない
    • デザインが主目的では無い
  • 検索性能もそこまでがっつり無くて良い
    • ナビが充実していれば良い
  • SEOとかブランドは考えない
    • 自分のドメインが〜とか、既存ナレッジサイトのSEOが〜とか考えると切りがない

また、自分が構築したいナレッジシステムとしては以下のような要件まとまりました

  • 情報を増やす・アップデートが容易であること
  • 似たような情報を横断的にまとめることが出来ること
  • 自分はもとより、他の人が閲覧が容易であること

したがって、GitLabでパブリックなレポジトリで良いという結論に至りました

GitHubじゃなかったのか

同様のサービスとして、GitHubが挙げられると思います

どうしてGitHubでは無くGitLabを使うことにしたかと言うと、単純にGitLabが好きだからという理由のみです

同様のことがGitHubでも出来ると思いますので、気が変わったらGitHubに移行するかもしれませんw

まとめ

ナレッジシステムなので、常にアップデートし続ける必要が有ります

頑張ります!! ( ・ㅂ・)و ̑̑