社内ドキュメントはなぜ更新されないのか？情報の鮮度を最小限の運用負荷で維持する「イミュータブルドキュメントモデル」のススメ - KAKEHASHI Tech Blog
はじめに こんにちは。カケハシの各プロダクトを支えるプラットフォームシステムの開発チームでテックリードを担当しているkosui(@kosui_me)です。 プロダクト開発の世界では、明瞭な社内向けドキュメントを書くための方法が数多く提案されてきました。読者の中には、製品要求を明瞭にするためにPRD (Product Requirements Document、製品要求仕様書) を書き、プロジェクトの背景から全体の設計やその代案について明瞭にするためにDesign Docsを書き、アーキテクチャに関する意思決定の記録を明瞭にするためにADR(Architecture Decision Record) を書いてきた方も数多くいらっしゃると思います。 しかし、どんな素晴らしいドキュメントも、何故か更新されなくなります。新メンバーへのオンボーディングのためにインフラ構成図を検索したあなたが見つけた
よい製品でもガイドやチュートリアルが難解だと使ってもらえない、ではドキュメントの正しい作成方法とは？
どんなに優れた製品でも、その製品のドキュメントが難解だとユーザーの拡大は難しいもの。そんなドキュメントの「正しい作成方法」について、ウェブアプリのビルドサービスを提供するDivioが解説しています。 The documentation system — Documentation system documentation https://documentation.divio.com/ よい製品でもよいドキュメントがなければユーザーは増えないと多くの人が認識しているにもかかわらず、「正しいドキュメント作成方法」を知らないために、ドキュメント作成に失敗している事例が後を絶たないとDivioは指摘。Divioはドキュメントを「実践的か、理論的か」「学習時に役立つか、作業時に役立つか」の2軸に当てはめ、「チュートリアル」「HowToガイド」「リファレンス」「説明・議論」の4つに分類しています。
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
Pythonで始める ドキュメント・インテリジェンス入門 / Introduction to Document Intelligence with Python
