myゲーム趣味レーター

ゲームデザイン、ゲーム制作、ゲーム史、古典蒐集、ゲーム研究、ゲーム開発者教育、積みゲー

【ゲーム開発】脱Excel!Confluence仕様書のススメ

この文章は、ゲーム制作者が自由な記事を作るアドベントカレンダー[12/19]の記事*1です!  

ゲーム制作にかかわる人が自由な記事を作る Advent Calendar 2024 - Adventa

 

Confluence Logo, symbol, meaning, history, PNG, brand

 

本記事は主に、以下のような読者に対して少しでも力になれたらという思いで書いています。

  • 今のプロジェクトの仕様書を忌まわしきExcelからConfluenceに変えたい!
  • 新たに入ったプロジェクトの仕様書がConfluenceでワケわからん!こわい!

【目次】

仕様書というカルチャー

X(当時Twitter)にて、ゲーム業界人の多いTLで私が取ったアンケートを見てほしい

「仕様書」とは、日本ゲーム業界ならではの文化がもたらした実に特殊なドキュメントであり、一般的なシステムエンジニアリング的文脈の仕様書とは少し異なる。

ゲーム開発における仕様書とは、ゲームのルールや仕組みについて設計や要件などを記載してプログラマやアーティストへ発注するためのドキュメントであり、この文書の作成はおそらく、多くのゲームプランナーが最も多く対峙することになる業務であろう。

「プランナーがイチからゲームを企画できる機会なんてほとんどない。ワシらは"シヨーショ"を書くのが仕事なのさ」と、新人時代にはよく言われたものだ。そんな夢のない、地味な書類*2なのである。

Excel仕様書が普通だと思っていた

さっきのアンケートに戻ろう。

この仕様書と呼ばれるドキュメントは、Excelなどの"表計算ソフト"を使って作成している人が半数近くいるらしい。

確かに私も、1社目で入った某大手ゲーム会社がExcel仕様書だった。

入社して研修が終わると、さっそく先輩方からありがたい秘伝のExcelテンプレートをいただき、必死に行間隔を揃えて方眼紙にしたり、A4印刷にピッタリ収まるように範囲を調整したり、最終更新日の日付を欠かさず更新したりしたものだった。

涙ぐましい新入社員のブルシットジョブである。若いうちはこういう細かい仕事ができるかどうかで評価されるのさ~と思って、必死に頑張った。

(最近趣味で作ったExcel仕様書のサンプル。このフォーマットを徹底して仕込まれたので、Excelで書かなくなって10年近い私でも未だにそれっぽい体裁は書ける。こわい)

Confluence仕様書に衝撃を受ける

しかし、その後一身上の都合で転職した私は、2社目でConfluence(通称コンフル)に出会ったことで価値観がガラっと変わり、今やすっかりExcel仕様書に戻れない体になってしまったのである…!

最初こそ、こんな実体のないフワフワしたものにゲームの何がわかるんじゃ!魂がこもっとらん!と思ったりもしたが、少し慣れてくると、もう便利で便利で。

Excelでミリ単位のセル幅調整をしていたあの頃がアホらしく思えてくる。なんだったんだあの時間は……

(Confluence仕様書のイメージ。Excel仕様書と比較するとだいぶ様子が違う、というか価値観が異なる)

 

さっきのアンケートでは54%のExcel系が1位であったが、実は2位がConfluneceやNotion*3などの「Wiki系」であった。

全体の28%と、これは決して少ない数字ではないはずだ。近年もますます利用者が増えている注目のツール形式である。

 

前置きが長くなったが、以降は伝統的なExcel仕様書の欠点と、それを補うConfluence仕様書のメリットを取り上げ、皆さんにもぜひConfluence仕様書の導入を検討してもらいたい!という主旨で書き記していく。

Excel仕様書で困ったこと

とあるExcel仕様書の現場では

  1. 仕様書がネットワークドライブに生で格納される
  2. それを各自がローカルにダウンロードして編集、更新
  3. 更新したファイルを、Slackに添付して確認してほしい人へ送付
  4. 受け手は添付ファイルをいちいちダウンロードして閲覧

…という文化があった。
バージョン管理すらされておらず、同名コピーがどんどん増えていった結果、どの書類を信用してよいかわからくなるのだ。
(この場合は、Excelというよりバージョン管理体制の問題が大きいのだが…)

Excel仕様書でのやり取りをする現場では、資料保守の観点で以下の問題があった

1. 保守性の低さ

  • 目次や変更履歴*4の管理が大変
    • 気を利かせて、紙面上に手書きや関数でコツコツ更新する必要がある
  • 本当に最新版なのか信用できない
    • 「_最新1219」「_FIX(2)」などの最新版っぽい命名が複数存在したりする
    • 実は誰かがローカルで編集中で、ネットワークドライブに上がっている情報は古いかもしれない
  • 複数人で同時に編集しづらい*5
    • 別の誰かがローカルに落として編集していたら、自分の編集と競合するかも?

2. 検索性・閲覧性の低さ

  • 目的のファイルを見つけられない
    • どのフォルダ階層にあるのかわからない
    • ファイル内の文章まで検索できない
    • 同じ名前のファイルが別のフォルダにあったりすると、つらい
  • いちいちダウンロードが必要で面倒
    • メールやSlackで送られた文書を閲覧するには、いったんローカルにDLしないとマトモに閲覧できなかったりする
    • 開くのが面倒だと、それだけその資料を見る人が減る
    • DLするたびにローカルに同名ファイルが増え、「_最新1219」命名や二重管理が発生する温床に
  • 他の仕様書へのリンクが切れる
    • 誰だ仕様書の名前を変えてフォルダを移動したのは!
    • もうその仕様書見つけられないよ!

3. フォーマット不統一の面倒臭さ

  • 担当者やプロジェクトごとに異なる独自のフォーマット
    • 新しい職場に入ってまず始めるのは、我流フォーマットの再現
    • 他人の作成した仕様書を更新しづらい。どこが壊れるかわからない
  • レイアウトを整えるコスト
    • 読みやすさや印刷範囲の調整に時間がかかって面倒くさい
    • セル結合や複雑なオートシェイプを使いすぎると、あとからレイアウトの融通が利かなくなったりする
    • 行や列を追加することで、意外なところで図表や関数が崩れたりする

これらの問題は、個々人の注意力や根性、あるいは秘伝のフォーマットへの忠誠心で解決するものもあるかもしれないが、極力はそんなことにコストを割かず、「しくみ」で解決したい。

コンフル仕様書のメリット

では、Wiki系ツールの代表格であるConflunenceを使った仕様書(以下コンフル)とはどのようなものか。それによるメリットは何か。

ざっくりまとめると以下の通り

1. 保守性の高さ

  • クラウド上に置いてある1つのドキュメントを、ブラウザ上でそのまま編集!
    • 最新版を直接いじるので、二重管理が起こりようがない!
    • Slackで共有するときは、URLを貼るだけでOK!
  • 目次や変更履歴は自動反映
    • いちいち手動で書き換え不要!
  • みんなで同時に編集可能
    • 議事録やブレスト、大きなリスト更新に便利!
    • 競合も発生しえない!

2. 検索性・閲覧性の高さ

  • キーワードで全文検索すれば、読みたい資料がすぐ見つかる!
  • ワンクリックで即編集、即反映!
  • ダウンロード不要で、ブラウザから気軽に直接コメントできる
  • 別の仕様書やJIRAチケットへのリンクが切れない!
  • 動画やプロトタイプの埋め込みができる!

3. フォーマットの統一を担保

  • レイアウトやフォーマットは自動!

    • 見出しやレイアウト、印刷範囲などを毎回微調整する必要なし!
    • 箇条書きがとにかく便利で爆速!
  • あらかじめ作ったテンプレートをワンボタンで生成!
    • チーム共通のフォーマットを、誰もが正確に迅速に使える

コンフルの実際の機能例

実際のサンプルのセクションごとに、機能とメリットを説明していく。

1. 冒頭セクション

仕様書のタイトルや更新日時、目次、概要などを記載する冒頭部分だけでも、コンフルの利便性がいかんなく発揮されている

  • 検索機能
    • まず、コンフルの資料探しの基本は「キーワード検索」
      • タイトル、内容、コメントなどまで検索してくれる
    •  もっと使いこなすと、チーム全体の更新タイムライン表示とか、特定ラベルがついた記事を一覧リストにするとかも可能
  • 作成者の自動入力
    • コンフルの利用者はプロジェクトや会社単位でユーザー登録されるので、新規作成ボタンを押すと勝手に自分の名前が刻印される
      • いちいち自分の名前を書かなくてよいのだ
    • また、最終更新日時や更新者も全て自動で記録される
      • 特定の更新までバージョンを戻すことや、差分を確認することも可能
  • JIRAとの連携
    • チケット管理ツール「JIRA」と同じ会社*6が作っているので、連携が強力(目玉機能かも)
    • チケット名やステータスをリアルタイムで反映するので、その仕様に紐づくタスクなどを添付しておけば便利
      • このときチケット側からも相互リンクが貼られるので、作業チケットを渡されたプログラマが仕様書を探す手間がなくなる!
    • もっと使いこなすと、複数のチケットをフィルタリングして分析してグラフにすることも可能
  • 他ページとの連携
    • 関連する仕様書のタイトルさえわかれば、簡単にリンクを貼ることが可能
    • 万が一リンク先の名前や場所が変わっても、リンク切れしない!すごい!
  • 目次の自動反映
    • 「目次」という機能を配置さえすれば、あとは勝手に見出しの大きさを見て階層構造の目次を作ってくれる
      • もちろん文章を変更すれば、目次も自動的に変更される
    • ページ内の目次だけでなく、ページ同士のページツリーを作ることもできる
  • 統一化された見出しフォント
    • フォントの大きさを数字で入力するのではなく「見出し1」「見出し2」などから選択する方式なので、フォーマットが統一される
    • サンプル画像のように簡単に色を付けたりもできる
    • 見出し単位でリンクを生成できる
      • 「この資料のこのあたり見といて」というときは、その場所の見出しリンクをSlackとか別のページとかに貼ればよろしい
  • YouTubeの埋め込み
    • 参考動画のリンクを貼れば、資料上でリアルタイムで再生できる!
      • アクションや演出系の仕様には超便利!
      • 時間指定やクリップにも対応
    • YouTube以外にも、GIF動画、X投稿、XDやFigmaの画面プロトタイプ、Miroのホワイトボードなども埋め込み可能!
      • XDやFigmaに至ってはその場で動かせるぞ!すごい
  • テンプレート化
    • 冒頭部分の構成をチームで統一したい場合は「テンプレート」機能を使う
    • ワンクリックで同じ構造のページを作成可能に!

2. 内容セクション

  • 箇条書き
    • コンフルの基本は箇条書き
      • 楽々にサクサクと、伝わりやすい文章を書ける!*7
    • Excelで箇条書きをしようと思うと、セル内で改行&中黒点でやる人と、行を分けて書く人とで分かれてしまったり
  • ニ段組みレイアウト
    • ワンクリックで段組みにできる
    • 画像の横に文章を配置するレイアウトなどが簡単に作れる
  • コメント機能
    • 文章に直接蛍光ペンみたいのを引いて、コメントが書ける!
    • コンフル文化的には、書類はどんどんオープンにして、通りすがりの読者からどしどしコメントをもらうのが良さげ
      • いちいちダウンロードなどせずブラウザ上で閲覧できるため
    • ちなみに、コメントへのリンクを生成することも可能

3. 結びセクション

  • 表とのリンク
    • デザインリソースの発注リストなど、大きな表を作りたい場合は、正直コンフルよりExcelの方が向いている
    • その場合、以下の方法でコンフルと紐づけるのがオススメ
      • 表を載せる専用の別ページを用意して、仕様書にはそこへのリンクを貼る
      • 表を載せる専用のページには、One DriveなどにアップしたOnline Excelのリンクを貼る
      • 埋め込み表示にすることで、常に最新のExcelデータをみんながブラウザで閲覧可能になる
  • 更新履歴
    • もちろん、バージョン管理や更新日時の自動スタンプに対応
    • 誤って削除などしてしまっても、すぐに犯人がわかるぞ(簡単に戻せる)

強固なExcel派への反論ケース

便利そうなのはわかった。

しかし、慣れ親しんだExcel文化から移行するのはどうしてもストレスがかかるもの。ときには強固なExcel派から反対意見を受けることもあるだろう。

そんなときのために想定問答を用意しておいたので、各自いい感じにアレンジして戦ってほしい

Excelで書く方がフォーマットが自由で便利!」

  • 本当に"自由"が必要ですか?

    •  フォーマットの "自由度" は、実は管理コストの増加につながっています

      • 担当者ごとに異なるフォーマット → 読みにくい
      • セルの結合や装飾の乱用 → 更新や修正が大変
      • 過剰な装飾時間 → 本来の仕様記述時間の圧迫
  • Confluenceでもできることたくさん
    • テーブル、画像配置、文字装飾など、必要な整形機能は全て揃っています
    • テンプレート機能 で、必要なフォーマットを即座に呼び出せます
    • マクロを使えば、JIRAのチケット一覧やステータスなども表形式で表示可能
  • これらの利便性に対して、いちいち手動で更新する手間が勝りますか?
  • それでも仕様書のデザインに独自性を出すことに、どれだけの価値がありますか?
  • ※オートシェイプを組みあわせて複雑な図を作成するのは良いのですが、生データではなくグループ化して画像として添付した方が、行追加などでズレたりしなくて◎

「ツールを覚えるのが面倒!」

  • 実はExcelよりも直感的で、学習コストは低いです
    • いわゆるマークダウン形式で、noteやブログを書いたことのある人ならなじみやすいはず
    • GUIも豊富で、基本的な機能であれば数週間で会得できます
  • 複雑な関数やマクロ、条件付き書式などで魔改造されたExcelに対処できますか?
  • 今後もNotionなどWiki型、クラウド型のツールはより普及していくと思われます
    • プライベートでも使いこなせると便利!
    • 仕事に乗じてこの機会にサクっと習得してみては?

「表をつくるのはExcelの方が向いているのでは?」

  • それは、本当にそう
    • そこはさすがにExcelさんの本領発揮です。それは否定しません
  • コピー乱造などが防げればOKなので、クラウド化→コンフル埋め込みなどを駆使して、いい感じに使い分けたいですね

「Confluenceのアカウントはお金がかかるのでは?」

  • そこに気づくとは…
  • JIRAを使っているプロジェクトなら、間違いなくオススメです
    • 圧倒的にタスク管理効率が上がります
  • 中長期的に見て、その予算に見合うメリットがあるということをご理解いただきたいです
    • with 社内のコンフル経験者を集めたチーム

モダンな資料管理の5箇条

最後に、私のこれまでの経験則などから編み出した、Wikiクラウド時代のモダンな資料管理5箇条を書いて終わりとする。

  1. 誰もがいつでも最新版を閲覧・編集できるようにせよ
    • ローカルで作業するな、クラウドに上げよ
    • DMするな、オープンチャットでやれ
  2. 二重管理せず資料は1つにせよ
  3. バージョン管理せよ
    • 共有フォルダで上書きするな
  4. 外部からデータを参照しやすくせよ
    • 1項目1ページ、1セル1データをなるべく守れ
    • 一意となる命名にせよ
  5. 根性や心がけではなく、環境で解決せよ
    • 見た目にこだわるな。元から良い見た目になるようなテンプレを用意せよ
    • 通知や定期更新は自動化せよ
    • これらの原則もしくみで実現せよ

おまけ:コンフルについてもっと詳しく知りたい人へ

これらの資料が詳しい。
ちなみに私は回し者ではない。

youtu.be

www.slideshare.net

==============

*1:なんと偶然にも、12/20の方がゲーム開発におけるNotionの使い方の記事なので、近しいネタになりましたね。こちらも楽しみ↓
Notionによるゲーム開発のシナリオ・スケジュール・ネタ帳・開発データ管理 - ばけねこぽーたる

*2:仕様書の良い書き方について詳しく知りたい方は、以下の記事や書籍がオススメ
分かりやすい仕様書を作るための『考え方』と『テクニック』|だらねこ
プランナー一年生のためのゲーム仕様書の書き方

*3:イマドキの就活生はNotion上でポートフォリオを作って公開したりしているらしい。私もマネして、Notionでポートフォリオを公開している
ポートフォリオ | Notion

*4:変更履歴に関しては、SVNやHelixなどバージョン管理環境を導入すればある程度解決する

*5:同時編集に関しては、One DriveやGoogle DriveなどでExcelクラウド化すれば解決する

*6:製品 | Atlassian

*7:テクニカルライティングの基本 - Speaker Deck