Zenn
📖

ケイブック（洞窟本）という新しいドキュメンテーション手法について

に公開
仕事術
Scrapbox
ドキュメンテーション
Cosense
idea

この記事では二点紹介します

  • 1: 今回書いた「低性能の仕事術」について
    • 以下本作
    • IT 要素はほぼありませんが、強いて言えばマネジメントやコラボレーションに役立つかもしれません
  • 2: 本作を書くのに使った表現方法「洞窟本」について
    • 本題です
    • 洞窟を探索するかのように読んでいく表現形態です

1: 低性能の仕事術について

👉こちらからアクセスできます

背景と概要

多様性（Diversity）、多元性（Plurality）といった言葉があるように、ひとりひとりのあり方は思っている以上に多彩です。「努力や心持ちが足りていない」で済むとは限りません。

まだ捕捉されていない概念として 低性能 があると考えます。頭の性能が悪いのです。PC でたとえると、普通ならメモリが 32GB あるのですが、低性能は 1GB しかないようなものです。前者の当たり前はことごとく通じませんし、「こんなこともできないのか」といわれても成すすべがないのです。もちろん、人間なので「増設しましょう」というわけにもいきません。IQ は鍛えられるという人もいますが、そんな単純でもありません。どうやら努力ではどうにもならない、根本的なスペックというのがあるようなのです。

本作はそんな低性能について、ひとりの当事者としてまとめてみたものです。特に同じ当事者の助けになったら幸いですが、そうじゃない人にとっても「低性能とはどんな感じなのか」「どう扱えばいいか」を考えるヒントになると思います。

2: 洞窟本（ケイブック）について

造語ですが Cave + Book で Cabook（ケイブック, 洞窟本）です。以下ケイブックと呼びます。

概要

  • ダンジョンを探索するかのようにザクザク読み進めていくドキュメンテーション手法 です
  • Cosense のような「ネットワーク構造をつくりやすいツール」を使って、ページ間にリンクを張る形であちこち行き来させます
  • 理論的にはただの Wiki やウェブサイトと同じですが、探索のしやすさが重視されています

デモ

低性能の仕事術を読んでみてください。

内容は理解せずとも、リンクを辿っていくだけで「なるほどこんな感じのドキュメント手法なのね」と体感できると思います。

ケイブックのつくりかた

Cosense を例にします。

  • といっても、普通にプロジェクトをつくって、ページをつくって、リンクでつなげていくだけです
  • ケイブックとしてつくるために心がけることが色々あります
    • 以下雑多に紹介していきます

ページには行の塊を並べます

  • ケイブックでは文章やストーリーを読ませるのではなく、「情報の塊」を配置すると考えます
    • 箇条書きだと書きやすくて便利です（Cosense が推奨する書き方でもあります）
    • 塊と塊は、空行で区切りましょう

出入口リンクをつくります

  • ページSからページDにリンクした場合: S → D
    • D 側の 先頭 に、Sへのリンクを書きましょう
    • これは D に出入口を設置しているようなものです
      • これにより読者は、あとで戻るボタンを使わずにページ S に戻れます
      • また、Cosense はリンクの位置までスクロールする（黄色背景）ので、このように書いておかないと読者が現在地を見失いやすいです

こまめにページ化しましょう

プログラミングと同様、長すぎてごちゃごちゃしたページは読みづらいので、適当に整理してページ化しましょう。関数化、クラス化、モジュール化と一緒です。

無闇なページ化はやめましょう

相反しますが、だからといって小さくページをつくればいいというものではありません。

  • プログラミングも同じですが、無闇に小さな関数をつくって部品化すればいいというものではありません
    • （OOP のスタイルとして意図的にそうすることはありますが……）
  • 一つのページ内に塊をある程度たくさん配置したほうが、シームレスで読みやすいこともよくあります
    • このあたりのバランスは、ケイブックをつくる人のセンスに委ねられるでしょう……

玄関口をつくって、ピン留めしましょう

  • ケイブックでは ピン留めしたページだけを表示させます
    • なので、玄関口となるページを一つつくって、これだけをピン留めします
    • つまりケイブックでは、まず玄関口の一ページだけが表示される見せ方にします

作業机と Settings をつくります

本作でいうと、以下に相当します。

作業机は作業用ページです。読者には見せません。タスクリストやメモなど適当に使ってください。使わなくても構いません。ちなみに、Cosense 上級者であれば目ざとく見つけてアクセスしてくると思います。そういうのを楽しむのもケイブックの醍醐味の一つです。知る人ぞ知る裏庭に、読者が入り込んでくることもあるのです。

次に Settings ですが、これは Cosense の仕様で、プロジェクト全体にかかる CSS を定義できます。ケイブックではこの機能を使って探索以外の操作を封じます。

探索以外の操作を封じる

ケイブックでは探索だけさせたいので、それ以外のページ一覧や検索を封じます。

前述の Settings ページにて、CSS を使って非表示にさせます。style.css というコードブロックにはりつけてください。

※Cosense の仕様変更により通用しなくなることがあります。2025/06/02 時点のものです。

/* 関連ページリストを非表示にする */
.related-page-list {
    display: none;
}

/* ページ一覧をピン以外非表示にする */
.page-list-item {
  display: none;
}
.page-list-item.pin {
	display: block;
}

.search-form {
	display: none;
}

/* quick launch */
.page-list-mode-menu {
	display: none;
}
.page-sort-menu {
	display: none;
}
.page-filter-menu {
	display: none;
}
.page-list-translation-menu {
	display: none;
}

以上です

こんな感じで、ケイブックをつくっていけると思います。

ぶっちゃけページとリンクをつくってるだけなので、最終的には作り手のセンス次第です。とにかくゲームでダンジョンを探索するように、かんたんにあちこち辿れるようにするのがミソです。そのためなら冗長なリンクを張ることもあるでしょう（出入口リンクなど）。リーダブルコードなど読みやすさ（リーダビリティ）の概念がありますが、ケイブックでは探索のしやすさ・心地よさを示す エクスプロアビリティ（Explorability） があると思います。

皆さんも、ぜひ自分なりのケイブックを考えてみてください。

p.s. ケイブックと名付けてみましたが、いかがでしょう。良い名前を募集中です。。。

GitHubで編集を提案

Discussion