本文へ移動

50,000語のソフトウェア文書を執筆

GitHub、Craft、ConfluenceでMarkdownを使い、50,000語の詳しいソフトウェア文書を執筆。知識の蓄積と工程の透明性を確保した。

50,000 知識を残すために執筆した文書の語数

状況. 製品と仕事の進め方に関する重要な知識の多くが、人の頭の中にあった。新しい人が来るまでは問題に見えずとも、受け入れは遅くなり、誰かが退職すれば組織の記憶の一部が永遠に失われかねなかった。

課題. 知識を人の頭から取り出し、実際に保管し利用される文書にすることを目指した。読めるほど明確で、1か月で放置されず維持できるほど構造化する必要があった。

行動. 内容に合う場所を選び、GitHub、Craft、ConfluenceにMarkdownで多くの内容を自ら執筆し、最終的に約50,000語になった。設計、工程、実際の操作方法など、人が繰り返し尋ねる内容を扱った。版管理と同じく、見つけやすさも重視した。所在がわからない文書は、存在しないのとほとんど同じだからだった。

結果. 知識が失われやすい状態を脱した。新しい人は早く仕事を理解でき、工程は記憶から再構成せず参照できるものになった。信じるだけでなく、どう、なぜ仕事を進めたかを見られる、監査可能な状態となった。

  • 古いタイプライターのキーに置いた手
    写真: rawpixel / Pixabay
  • 本棚、図書館、文学
    写真: JayMantri / Pixabay

この経験をお客様のプロジェクトに

「50,000語のソフトウェア文書を執筆」を、お客様の組織の似た課題を考える出発点にしてください。この実績を支えたサービスを、お客様のプロジェクトにも提供できます。 取引先、予算、設計について、知識に基づく別の見解が必要なときに、同じ側に立って判断を支えます。

サービスを見る お問い合わせ

結果の背景を確かめる

この事例の状況、判断、結果をご覧ください。どの部分がお客様の制約の下でも生かせるか、どこに別の方法が必要かをご相談いただけます。 50,000語のソフトウェア文書を執筆 — 50,000 知識を残すために執筆した文書の語数

サービスを見る お問い合わせ

より多くの実績の 一つです — そのすべてをこのサイトで公開しています。

どの項目も、状況、課題、実施内容、変化という同じ構成で記載しています。

すべての実績を見る

必要な改善を定める

必要な判断、影響を受ける人々、すでに検討した選択肢をお知らせください。選択に伴う利点と不利益を明確にし、推奨案を文書に残せます。

料金を見る お問い合わせ

人が離れるたびに知識も失われていませんか?

「50,000語のソフトウェア文書を執筆」の判断の背景についてお尋ねください。仕事内容を説明し、お客様のプロジェクトを検討できる担当者が対応します。

サービスを見る
welcome@engineer.company +45 50 10 61 84 デンマーク、コペンハーゲン
GitHub、Craft、ConfluenceでMarkdownを使い、50,000語の詳しいソフトウェア文書を執筆。知識の蓄積と工程の透明性を確保した。のQRコード
このページを持ち歩くhttps://engineer.company/ja/portfolio/wrote-50000-words-of-software-documentation/