stefafafan の fa は3つです

"すてにゃん" こと id:stefafafan のブログです

トップ > 技術 > 仕事でScrapbox使って情報整理する際に個人的に気をつけているポイント

仕事でScrapbox使って情報整理する際に個人的に気をつけているポイント

技術

こんにちは、私は日々SlackやScrapboxを仕事で利用していますが、ふと自分の気をつけポイントをまとめておこうと思ってこの記事を書きました。

主にScrapboxを使ってるときの話をしますが、ツールに限らない話題だと思います。以下のエントリのお二人と同じチームに現在所属しています。
medium.com

Scrapboxとは:
scrapbox.io

前提

まずチームでScrapboxをどう使っているかというと、

  • 職種によらず、Webアプリケーションエンジニア、iOS/Androidアプリエンジニア、デザイナー、企画、ディレクターなどなどみなさん使っています
  • 定期的に開催している会の式次第、議事録、新機能作る際の要件整理、タスクの洗い出し、日報、などわりと何でも書いてます

情報の種類

何でもかんでもまとめているうちに、そもそも「情報」にはいくつかの種類があると気づいたので、以下のような観点を意識して整理するとよりわかりやすい形になりそうとわかってきました。

整理途中の情報 vs 整理済の情報

メモを書いているとき、その情報が最初から整理されていることはほぼ無いと思います。Scrapboxなどにそのメモを急いで残して整理しないままほおっておくと、最悪本人以外読み解けない情報になってしまったり、そもそもそれがただのアイデアなのか確定された情報なのかが不明です。そのため明確にまだ整理されていないことがわかるようにするべきです。

  • 例: 「新機能A」というページに、新機能Aについての要件のブレストを箇条書きで書く
    • あとから別の人がこのページに辿りつくが、一体何がまとまっているのかよくわからずに困る

どうすると良さそうでしょうか。例えば以下のようにする。

  • 「新機能A」のページ内にさらなるセクションを一旦作る（例えば、「要件についてのブレストメモ」）。この下に箇条書きで書いていく
    • これをひたすらやっていくとページがものすごく長くなっていくので、そうなってきたら「要件についてのブレストメモ」項目を別ページに切り出しして、「新機能A」ページに「新機能Aの要件についてのブレストメモ」へのリンクだけ載せる、みたいな形にする
    • セクションやページで区切るとあとから読む人にとってよりわかりやすくて良い。
ある時点での情報 vs 最新情報

時間が経過するに連れ変わる情報もあります。「あるとき考えていたことはなかったことになったので、そのメモは消してしまって最終的に決まったことだけ残す」とやってよいならそれで良さそうですが、過去に話されていたことや、いまはないけど過去に存在した機能について「歴史」を残しておきたいこともあるはず。歴史かそうでないかを明確にしましょう。

  • 例: 「機能B」というページ内に2019年までの仕様と2020年以降の仕様が混じっている
    • 機能Bに関わっていない人などがみたときに混乱してしまう

どうすると良さそうでしょうか。例えば以下のようにする。

  • 「機能B」ページには最新の仕様のみ書いていく。そして例えば「歴史」コーナーを作って「2019/3 時点の機能B仕様」みたいなページへリンクする
    • また、時間軸と関係のあるページにはページのタイトルに日付を入れるようにする

5W1H

ある情報がまとまったページを開いたときに突然機能の紹介などもなしに要件だけ書かれていても難しいと思うので、5W1H全部常に書く必要はなくても近いことを意識すると良さそう。
ja.wikipedia.org

雑に書いてみるけど、例えば以下のように、ページの先頭にいつ誰が担当しているのかなどをまとめておくイメージです。

# 機能C

機能Cは現在開発中の 2012/3/4 リリース予定の機能
担当エンジニア: id:stefafafan
担当デザイナー: hogehoge

## 要件
企画要件は以下の通り
- ...
- ...
- ...

## タスクリスト
- [完] ...
- [着手中] ...
- ...

# 2001/2/3 機能Dについての会議の議事録
2030年のリリースに向けて要件をつめるために機能Dについて会議したときの議事録です

参加者:
- id:stefafafan
- hogehoge
- fugafuga

## 議事録
...

重複コンテンツ、表記揺れ

方針なくさまざまな情報をまとめつづけると、同じ情報が複数箇所に重複して残ってしまうことがあり、のちに参照する際に困ることがあります。あらかじめ方針を決めておいたり、新しくページを作るときにすでに存在しないかなどを確認するという方針で進めていく必要があります。

表記揺れの例
  • 2020/01/23 と 2020/1/23 みたいな日付を含むページ
    • ScrapboxではCtrl＋tで日付が決まったフォーマットで入るのでそれを使うようにしましょう、みたいな方針を決める
  • 「機能Aの要件」と「機能A/要件」と「機能A_要件」と「A機能の要件」などなど
    • 常に「機能○○/□□」でページ作っていきましょうみたいな方針をまず決めてチーム内に周知する必要がある

テンプレート

上記いろいろ書いてきましたが、これらを常に気をつけながらまとめていくのも頭を使って大変そうなので、繰り返し作るページに関してはテンプレートを用意しておけると良いですね。

たとえば…

  • 議事録のテンプレート
  • 障害対応時のテンプレート
  • 機能ごとのページのテンプレート
  • 定例や日報書くページのテンプレート

それぞれのテンプレート内に上で書いたような気をつけポイントが最初から盛り込まれていてかつ、新しくページ作るときはまずこのテンプレートから生成するというのをやっていくと自然と整理された形になるはず。

（最初に作ったテンプレートが最高とは限らないのでテンプレート自体の改善も必要）

ということで今回は情報整理について書きました。