Notionでの用語集運用にて検討したことや現在も継続していることについて振り返ってみた

Notion上で用語集を運用、メンテナンスする上で、必要としていることと継続メンテナンスする上での優先する目安としているもの等を振り返ってみました。
2022.08.16

Notion上に字引として用語集を作成したもののフラットなページだと各用語別の更新状況が把握し難く、対策としてデータベース化してみました。すると確認には要1クリックとなり、結果として手の出しにくい印象がでていました。事実、作成した当の本人が「開くの面倒」と思ったほどです。

ギャラリービューにてプレビュー設定に本文をあてることでざっくりと概要を掴むことができるようになりましたが、それでも他に課題があり全ては解消しきれていません。ふりかえりとして、現状どのように用語集を運用しているのかを書いてみました。

今回の用語集コンセプト

知識を得てから質問する、にしてみました。知識を得れば質問しないのでは、と思われそうですが訳があります。

クラスメソッド社内での独自用語は開発コード等含めるとそれなりの数となり、Slack上での会話もそれら前提の知識が必要になるケースも多々あります。色々な事情があり、同じ表記ながらも意味が異なる用語もあります。用語についての詳細はその用語を使う部署所属であれば雑談等で理解の機会も増えたりします。見方を変えれば、他部署社内スタッフはなかなか理解する機会がないとも言えます。そして、その状況下で質問が発生します。

サービス部にて運用している用語集は「質問は出てくるものである」という前提にて、質問にあたり混乱や齟齬を解消することを狙いつつ、該当用語の前提知識を持ってもらうことで基礎的な質問を減らし、施策担当スタッフに掛かる返答コストを減らすことも目標とします。

具体的には以下の要素で構成されています。

  • 用語の正式名称
  • 用語の意味
  • 用語ができた背景
  • 用語に関する過去の問い合わせ
  • 用語に関する参考資料

若干用語集の範疇を超えている気もしなくもありません。

用語の詳細を集める

既存資料から機械的にピックアップできそうにも思えますが、そもそもの記述がなかったりします。割と口伝です。

口伝だと書いたことの直接な裏付けを証明し難いために、あえて今更なようにも見える「確認ですが、これこれはあれあれっていうことでしたよね」という質問を行うこともあります。これの返答が裏付けとなるわけです。何も知らない状態での質問か、勘違いして覚えていたのか、どっちでも解消できるので便利です。

用語集を書き足す

提供する項目は多めですが、最初から全てを埋めようとはしません。そもそも問い合わせが存在しないなどでまず埋まらないものもあります。大体以下の項目が埋まれば上出来です。

  • 用語の意味
  • 用語ができた背景
  • 用語に関する参考資料

用語に関する参考資料は検索すればそこそこ出るものも多いのですが、問題は用語ができた背景です。問い合わせに当たって、この背景に関しての勘違いがあるが故に中々解決に至らないケースもあります。過去に何らかの解決策とされた経緯があればそれをそのまま書き、不明瞭な場合は不明瞭な状態で行われている質疑がないか検索します。大体正されているためです。正確な事を知る人に補完してもらうスタイルともいえます。

Notionの仕様と注意点

Notionの表機能を利用して用語集を作りたい場合、表の仕様のうち何を利用したいのか明確にしておきます。明確にならない場合は表の利用を控えておくのも一考です。今回は以下の要素を利用しています。

  • 検索窓
  • プロパティ(タグ、更新日付)

試してみた限り、表自身に備わっている検索窓は各レコードのプロパティのみを検索し、レコードページ内本文を検索してくれません。

逆にNotion全体検索はレコードページ内本文を検索し、プロパティを対象としていないようです。つまり、プロパティとページ本文の両方に同様の内容を書かないと、Notion全体検索と表検索両方には対応できないということになります。

今回の用語集ではまず本文を書いた上で、本文を検索用のプロパティに貼り付けることにしました。プロパティへの貼り付けはデータベース検索対策のため任意です。用語集までスタッフがたどり着けることが第一とし、用語集内はデータベースのソートにて読み方さえ解れば見つけられると考えました。

バックリンクの表示

用語集は他ページ内でメンションリンクとして活用しており、参照された具合をバックリンクにて把握出来るようにしています。

被参照数が多いほど導線として役立っている点もあるため、更新の目安にもしやすくなります。

あとがき

現状の問題は追加すべき用語についての明確な基準が思い浮かばない点にあります。質問されやすい用語については追加済みであり、AWSの用語についてはまずはAWS公式の用語集に当たるほうが早いはずです。勿論公式の用語集で説明されていない点については用語集にて記述を追加しています。

現状のデータベースの検索窓だけを表示可能にし、検索した時点で初めて一覧が表示されるようになるとページ隅等に便利なオプションとして追加出来そうだと思いました。今後のアップデートに期待です。