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

ちら帳

喉元を過ぎると熱さを忘れる自分の為の、ちら裏メモ帳ブログです。

esaの運用ルールについて少しだけ考えてみた( ⁰⊖⁰)

esaを使い始めた #トノコト

Boostnoteをうまく使いこなせない系エンジニアのちらです。

最近一人でesa.ioを使い始めました。

全体的にUIが使いやすく、見た目もかわいいので結構気に入っています。

あとWIPという概念がとても良いですね。

ブログとかチケットとかの文章はなんとなく綺麗に書かないといけないという強迫観念に縛られて生きているので、 アウトプットが遅くなりがちなのですが、そのあたりの心理的障壁が下がって、個人的にはすごく刺さるものがありました。

また、Chrome拡張のtsuibamiを利用すると、メモ速度が爆速になります=͟͟͞͞ (\( ⁰⊖⁰)/)
ChromeVivaldiを使っている方におすすめです。

社内のナレッジ共有にも使いたい #トノコト

社内のナレッジ共有が滞りがちなので、会社でもesaを使えたらいいなあと思っています。
でも組織で使う場合は、運用ルールが整備されていないと、せっかくのツールの良さも活かされなかったりするんですよね…

ということで、esa歴3日の素人ながら、社内でのesaの運用ルールやテンプレートについて少し考えてみました。

前提

今回運用を考える上での前提やら想定やらです。

  • 社内全体で使用する(規模は中小レベルを想定)
  • 個人の知識の共有をメインとするが、他にも社内で共有したいことがあれば、基本的に自由に投稿して良い
  • 社外秘・社内秘の情報だけは書かない
    • プロジェクト内のルールや特有の設定などに関しては、プロジェクト管理ツール(Redmineなど)に書く
    • その他、外に出せない情報は社内専用の情報共有場所(社内wikiなど)に書く
  • WebhookはEmailのみ使用

WebhookにEmailしか使わないのは、単に私が職場でチャットサービスを使ってなくて、SlackやHipChatに詳しくないからです。

カテゴリ

何をカテゴリにして、何をタグにするかを悩みましたが、とりあえずこんな感じになりました。

※PCから見たときに縦に長くなるので、技術情報の第三階層はリストにするのをやめました。

カテゴリの説明

esa Tips:
esaのTips集です。 公式のProTipカテゴリみたいなものです。

経営:
エンジニアも経営のことを知っていた方が良いとよく話を聞くので、経営カテゴリを用意しました。

不勉強なのでこれ以上階層を切れませんでしたが、きっと経理、組織論、法務あたりの情報を共有するのだと思います。

マーケティング:
Webマーケティングの情報に関するカテゴリです。
営業の人が使う想定で用意しました。

このカテゴリも詳しくないので、これ以上の階層を切っていません。
Webエンジニア的にはSEOアクセス解析についての情報が共有されるとうれしいです。

技術情報:
技術に関する備忘録、はまったこと、発見したことなどを共有するカテゴリです。
一部、カテゴリを言語で切るか、フレームワークで切るか悩みましたが、なるべく言語で切ることにしました。

他のカテゴリとの関係を考えて、言語、フレームワークは必ずタグで記述する決まりにします。
この時、タグに言語やフレームワークのバージョン番号は書かない方針にします。

面倒がって書かない人がいるでしょうし、バージョンが関係する情報はその旨がドキュメント内に書かかれるはずなのでそれで良いかなという判断です。

QAコーナー:
QAコーナーはStack Overflow的なカテゴリです。
ここに記事が投稿されたらメーリスに通知するようにしておきます。

内容が解決したら、アーカイブするか、技術情報のカテゴリへ移します。

社内チャットなど、すでにナレッジコミュニティが他にあるなら、このカテゴリは無くてもいいと思います。

イベント:
技術展や勉強会といったイベントに関する情報を共有するカテゴリです。

イベントを主催するときのお知らせや参加レポを共有します。 開催情報のカテゴリに記事が投稿されたらメーリスに通知するようにしておきます。

書籍:
最近読んだ技術書やビジネス書などの情報を共有するカテゴリです。 本の概要や内容に関するメモ、所感を書いて共有します。

ドキュメントを書こうと思った本のドキュメントが既出の場合は、コメントにメモや感想を追記します。

これ以上、下の階層を増やすどうか悩みましたが、とりあえずタグを使った運用にして、ドキュメントが増えてきたらカテゴリを増やせばいいと思います。

ポエム:
ここでいうポエムとは以下のような文章を指します。

ビジネス文章としての整合性や第三者からの検証性を必ずしも重視せず,書き手自身の理想であったり熱意だったり危機感だったり,そういう何らかの感情の発露を自分の中で反芻してとりまとめた表現した文章や図面の事。規模は数行から数十行であることが多い。
第1回 事業会社における開発とポエム:会社で「ポエム」を綴ろう! ~ポエム駆動で理想を語ると社内の風が変わる!~|gihyo.jp … 技術評論社 

ポエム駆動型開発を取り入れないにしても、こういうのを吸い上げられる場所って大事だと思うんですよね、というポエム。

雑記:
これまで紹介したどのカテゴリにも属さないドキュメントを共有するカテゴリです。

どのカテゴリに置いてよいかわからないドキュメントは、ひとまずここに書いておいて、 あとで新しくカテゴリを増やすなり、既存のカテゴリに移すなりするといった運用もできます。

テンプレート

ドキュメントをさくっと書けるように、必要事項を埋めるだけで良いようなテンプレートを用意してみました。

インストール手順テンプレート

f:id:chira_pym:20170320014119p:plain

#:raised_hand: 前提

### :dvd: インストールするソフトウェアとバージョン  
piyo 1.0

###  :computer: OS  
Windows 10

### :cd: 事前にインストールが必要なソフトウェア
なし

# :memo: 手順
1. hoge
2. fuga

#:warning: 注意点

イベント案内テンプレート

f:id:chira_pym:20170320041825p:plain

# :information_source: 基本情報

:calendar:  日時 : 
 
:office:  会場 : 

:black_nib:  テーマ:

# :scroll: 概要

URL: http://google.com

イベント参加レポテンプレート

f:id:chira_pym:20170320040939p:plain

# :information_source:  基本情報

:calendar:  日時 :
 
:office:  会場 :

:black_nib:  テーマ:

# :scroll: 概要

# :thumbsup: 良かった発表・勉強になったことなど  

# :books: 資料
<!--
このようにSlide Shareのスクリプトを埋め込むことができます。
<script async class="speakerdeck-embed" data-id="5633a9b0599d01326f2b4e55f5ecb48c" data-ratio="1.41436464088398" src="//speakerdeck.com/assets/embed.js"></script>
-->
# :coffee:   所感

書籍テンプレート

f:id:chira_pym:20170320133311p:plain

# :blue_book: タイトル

# :scroll: 概要

# :memo: メモ
<!--
読んだことに関して、何かメモしておきたいことがあれば記入してください。
-->

# :coffee:   所感

# :clipboard:  アンケート(任意)

**評価** : :star: × n

## 良かったこと
なし

## 良くなかったこと
なし

## どんな人におすすめか
なし

最後は管理者が頑張るしかない #トノコト

なるべく人が悩む要素はつぶしましたが、それでも、この構成でAWSやDocker関連のドキュメントはどこにどう書こうか、自分でも悩むので、まだまだわかりにくいカテゴリルールになっていると思います。

また、タグの付け方のルールをしっかり定義していないので、そのあたりに起因する問題も起きそうです。

ということで、実際に運用したわけではありませんが、運用時には以下のことが想定されます。

  • カテゴリやタグが乱立する
  • ドキュメントに期待するタグをつけてもらえない
  • ドキュメントが重複する

もともと情報が育ったら整理することを前提としたサービスなので、週1、あるいは月1でドキュメントを整理する時間を設けて、その時にこういったドキュメントの整理もした方が良さそうです。

その時に、それこそドキュメントの整理時のルールを共有するようにしたら良いのではないかと思います。

所感

遅筆なのでここまで書くのに体力と時間をかなり持っていかれました。
お昼寝して起きたら、もっとすごい人たちのちゃんとした記事が上がってるに違いないです。

それではおやすみなさい(:3[___]