概要

• 最近良く「markdownで色々情報を残すのが便利なのはわかったんだけど、Toolを何使うと便利なの？」と聞かれるので、blogにしておく
• wikiエンジンのsurveyは https://scepter914.github.io/blog/2018/20180819_wikiengine/に(ちょっと古い情報だけど)
• 自分の使っているシステムは https://scepter914.github.io/blog/2018/20180210_gollum/ に（これも若干古い情報だけど）

使う状況によって便利なツールが違うので場合わけ

1. 一人
   1. オフラインでノートPCで編集したい
   2. 複数の端末で編集したい
2. 複数人でwikiを使う
   1. 単発プロジェクト(数日単位)
   2. 単発プロジェクト(数カ月単位)
   3. 大きいプロジェクト

1. 個人でwikiを使う

• 個人用途ならデータベースを扱うんじゃなくて、git baseの方が手軽だしいいんじゃないかなって個人的には思っている
  • 移植しやすい
  • 生のmarkdownファイルを扱うことが出来る
• 基本的にgit baseで動いているものなら正直なんでも良いとは思うけど、ユーザー的にはGollumとGititが多いと思う

1.1 オフラインでノートPCで使いたい

• Gollum or GititをノートPCのバックグラウンドで起動して、localhostでアクセス

1.2 複数の端末で編集したい

1. Githubのプライベートリポジトリにマークダウンのファイルを置く

   • 多分これが一番手軽、 private化も簡単
   • Github上で
     • スマホからもraw fileが編集できる
     • ページ上のリンクをURL指定すればGithub上でwikiができる（？）
   • git pullして手元のPCで編集も可能
     • オフラインで作業も出来る
     • gitコマンド、ファイル検索のfd、検索のgrep等色々使える
     • VSCodeに噛ませるとほぼwikiなのでは
   • wikiを噛ませる
     • gollumとかを起動する
     • MDwikiを使うと何かinstallする必要もなくなるからもっと手軽かも(わりとおすすめかも)

2. ドキュメントクラウドサービスを使う

   • 手軽バージョンその2
   • Evernoteとか
   • 基本オンラインじゃないと作業できない

3. サーバーを建てる

   • 今自分が採用している形
   • サーバー側 (slave)
     • gollumがdockerで動いている
     • 常にとあるディレクトリの.gitを参照している
     • スマホ、デスクトップ, ノートPCから閲覧している
   • デスクトップ側 (master)
     • Gollumをバックグラウンドで起動して、localhostでアクセスして作業
       • 書く量が多い時はターミナルからVimで編集
     • 定期的にrsyncでサーバーにあるgitリポジトリにpush
       • リモートに置きたくないデータはrsyncに含めなければいいだけ
     • デスクトップとはクラウドファイル共有している
       • デスクトップでwikiのファイルを編集したらノートPCにも編集が反映されるみたいなシステムにしている

2. 複数人でwikiを使って情報共有

• ついでに何で連絡を取り合うとかのチーム開発的に必要なツールについての個人意見も
• 基本的にサーバーを用意するのは面倒なので、研究室とかそういった単位の人数出ない限りサーバー運用はコストに見合ってない印象
• サーバー建てる場合も、Git baseのwikiは運用に耐えない気がするのでDB baseの奴使った方がいい気がする

2.1 単発プロジェクト(数日単位)

• 例
  • エンジニア同士での旅行する時の旅の栞
  • 勉強会
• 基本的にサーバー建てるのはオーバーキルなことが多い(メンテコストに見合ってない)のでクラウド型にする
• 1ファイルで済む(旅行とかだと): HackMD
  • 共有が非常に楽なのと共同編集が捗るのでHackMDがお勧め
• 複数ファイルに分けたい: Github
  • 議論でオンラインで共同書き込みしたいときはHackMDで書いてから、クラウドwikiにログを移す形式がいい気がする
• 連絡ツール: discord
  • chatとmeetingを全部discordでやるのが便利な気がする
  • slackはオーバーキルかなぁって

2.2 単発プロジェクト(数カ月単位〜年単位)

• 例
  • Maker Faireに展示する
  • 勉強会の運用
• wiki: Github
  • 写真とかpdfとかは、Google driveで共有用ディレクトリを用意してそこにぶちこんでいって、リンクをgithubに書く
• 連絡ツール: discord or slack
  • ゆーてslackはオーバーキルな気がするんだよなぁ（個人の感想です）

2.3 大きいプロジェクト

• イメージとしては複数プロジェクトが立っているもの
• 例
  • 大学の文化祭でTechな出し物をする
  • Maker Faireに毎年展示する
  • 研究室とかもここにあたる気がする
• サーバー建ててメンテするコストが微妙な塩梅
  • 人が入れ替わらないならサーバー管理者固定でいいけど、変わるならクラウドwikiの方がいい気がする
  • サーバーを建てない低コスト管理
    • Scrapboxとかを運用しているところをよく聞くけど、良さげなクラウドwikiを僕は知らないです…（誰か教えてください）
  • サーバー建ててwikiを建てる
    • 少人数(2,3人): gitit
    • 大人数(4人より多い): crowi
• データ(pdfとか): google drive等のクラウド
• 連絡ツール: slack