読者です 読者をやめる 読者になる 読者になる

Usual Software Engineer

よくあるソフトウェアエンジニアのブログ

社内ドキュメントの重要性

社内ドキュメントって重要ですよね。
基本的に会社内でのみ必要な会社の知識って、脳みそのメモリの無駄遣いだし
外に書き出しておくことで属人性も減らせてハッピーだなと思っています。
自分はひたすら書き残すようにしているのですが
なかなか積極的に自主的にドキュメントとして残してくれる人って少ない気がしていて何故だろうなーと思うことがあります。
単に社内ドキュメントツールが使いづらいという理由であれば何かしら対処はできそうですが
書くのが面倒という理由も大きそうでうまい方法はなかなか思いつきません。
ともあれ、社内ドキュメントが充実していると

  • 新しくジョインしたメンバーの初期導入コストが下げられる
  • 属人性が下げられる
  • ノウハウが蓄積される
  • コメントをつけたり、いいねをつけたり、コミュニケーションがとれる

などなど、メリットはたくさんあります。
平たく言うと、ココを見れば必ず何かしらのヒントがある感じにしたい。
なのでとにかく自分はひたすらに書き残しています。
読んだメンバーが「これ便利だな、これ嬉しい情報だな」と感じてくれたら
同じように書き残すようにしてくれるだろうな、という思いも含まれています。

ぐだぐだ書きましたが、社内ドキュメントとしてはConfluence OnDemandを利用しています。
Confluence自体は2年ほど前から利用しているのですが
今はOnDemandの方を利用していてユーザ数が15人くらいなので安いものです。
ちょっとレスポンスが遅いのが気になっていますがww

Confuenceで残念なのは、もともとConfluenceの記法があってそれで記述していたのですが
今はエディタが直接Confluence記法では書けなくなっていてWordPressのように
見出しも太字も水平線もボタンで入力するようになっています。
Markdownのプラグインもありますが、Confluence記法もそうですが、
エディタ上でマクロのボタンを押してポップアップで開いた入力フォームの中に記述するという
これは使わないな、、と思ってしまう形になっています。

そこでMarkdownで書ける社内ドキュメントツールが欲しくなるわけですが
Qiita:Teamはとても良いプロダクトだと思いますが
結局のところ非エンジニアにも楽にドキュメントを書いて欲しいことから
とっつきやすいであろうConfluenceの方を採用しました。
(徹底的にMarkdownを覚えてもらう方向でもありだったかもなとは思いますが、冒険するところではないな、と。)

最後にメモ程度にConfluenceの活用法を少し載せてみます。

日報を書く

自分のスペースでブログで日報を書くようにすると、
月ごとにまとめて1ページで見れるし検索できるし他の人にもどんなタスクを行ったのかわかるようになるので
なかなか良いと思います。メーリングリストにメールで日報提出をするよりはマシかなと。

更新を通知する

例えばHipChatと連携を設定すれば、ドキュメントを更新した時にHipChatに通知することもできます。
Attlassian強いですね。JIRAも使っていたら連携できますね。
あとはページをウォッチしたりメンバーを注目したりすることで更新した時にメールで通知したりメニューバーでアラート通知したりできます。

ちょっと書き方がわからない
  • 箇条書き内の改行は"Shift + Enter"で入力できます
  • 箇条書き内の箇条書きは"Tab"で入力できます、戻す場合は"Shift + Tab"でできます
  • ページ内リンクがアンカーではできないようです、通常通りリンクの挿入で見出しとかのURLをコピーするしかなさそうです
  • これやりたいのにボタンないぞ...ってやつはマクロブラウザーで検索できます、Macなら"Cmd + Shift + A"です

そんなわけで社内ドキュメント大事です。ぜひ書きましょう。