GitHub

今僕が担当しているポジションを複数のスタッフが手伝うないしは引き継ぐことになりそうなので、どんなことをどんな手順で教えるか考えているのですが、相手が経験のある人間というわけではなく、口で一度説明すればすぐ出来るような作業でもないので、少しドキュメントにまとめておきたいと考えました。そうなっていれば、業務中にちょっとした迷いがあった時でも参照することが出来ます。僕の時もそんなのがあったら楽だったんですが、あいにく飲食店にはそんなものありません。大手チェーンにはいわゆる「業務マニュアル」はあるかも知れないけど、まあそういうことじゃないです。なぜならみんな料理人たちの頭に入っているから……

……と言いたいところですが、実際には単純にそういう文化ではないだけです。ドキュメントで(メモ書きでも良いけど)きちんと残すとということはあまりしません。そのおかげで「去年これどうしてたっけ」とか「前やったときはどんなだったっけ」とか、割と曖昧な記憶のまま、何人かで「多分こうなんじゃないか」と言って曖昧に進めていくことが多いです。それで上手く行ってるんだろうから別にそれがどうっていうわけじゃないですけど、僕自身が関わる部分についてはもうちょっとね。「記憶力」という個人差が大きく加齢に伴って減衰するような不確かな能力に頼るのではなく、誰が見ても同じように解釈できるドキュメントとして残しておきたいと思ったのでした。


というわけで、やってみた。


残念ながらここで全文公開するわけにはいかないんですが、簡単に言うと、

  1. GitHubでリポジトリを作る
  2. Wikiを作る
  3. テキストを執筆してpush
  4. 公開

これだけで終わりです。


全7ページ程度のドキュメントなので、最初に構成を考えるのに30分、ドキュメント執筆に2時間で合計2時間半ぐらいのやっつけ仕事でした。そのせいか執筆漏れが何点かあることにあとで気付いたので、それについては後日また加筆したいと思っています。


GitHub Wikiで何が嬉しいのか

嬉しいことは、

  • Markdownで書ける
  • git cloneしてどこでも執筆できる
  • 技術ある人がいればフォークして更新を引き継ぐことも可能
  • 公開リポジトリなら、Wikiも公開できる

て感じかなあ。AtomエディタのMarkdownエディタ使って書くと目次も入れられるしすごい楽で。

非エンジニアの人と一緒に更新となると、GitHubのWikiではちょっとハードルが高すぎると思いますが、エンジニアだけが更新するなら問題ないですね。git cloneで色んなところに持って行けるのは、実は結構便利。



僕がこれを用意したところで、会社の文化は1つも変わらなさそうですが、大学生バイトには割と受けが良かったみたいです。多分ドキュメントを書く面倒くささみたいなの、大学生にはわかるんでしょうね。飲食店の社員はそんなのわからないと思いますが(笑)でもこれを用意することで、彼らのモチベーションが上がるんならお安い御用です。



手軽にドキュメントを執筆したい、Wiki的な何かで残しておきたいという人には、GitHub Wikiでのドキュメント執筆、結構オススメです。お試しください。
  • About

    I'm a web designer/programmer in Kyoto, Japan. Also work as a blogger, DJ.

    NOBODY:PLACE is my personal blog since 1998. Everything I'm interested in is here.

    See Also
    Other Works
    Feed
  • Recent Hatena Bookmark
  • Monthly Archives
    Categories