50,000語のソフトウェア文書を執筆
GitHub、Craft、ConfluenceでMarkdownを使い、50,000語の詳しいソフトウェア文書を執筆。知識の蓄積と工程の透明性を確保した。
2022 – 2024
状況. 製品と仕事の進め方に関する重要な知識の多くが、人の頭の中にあった。新しい人が来るまでは問題に見えずとも、受け入れは遅くなり、誰かが退職すれば組織の記憶の一部が永遠に失われかねなかった。
課題. 知識を人の頭から取り出し、実際に保管し利用される文書にすることを目指した。読めるほど明確で、1か月で放置されず維持できるほど構造化する必要があった。
行動. 内容に合う場所を選び、GitHub、Craft、ConfluenceにMarkdownで多くの内容を自ら執筆し、最終的に約50,000語になった。設計、工程、実際の操作方法など、人が繰り返し尋ねる内容を扱った。版管理と同じく、見つけやすさも重視した。所在がわからない文書は、存在しないのとほとんど同じだからだった。
結果. 知識が失われやすい状態を脱した。新しい人は早く仕事を理解でき、工程は記憶から再構成せず参照できるものになった。信じるだけでなく、どう、なぜ仕事を進めたかを見られる、監査可能な状態となった。