システムのドキュメント整理と新メンバー加入時の説明順序 - Qiita

この文書について 構築済のシステムについて、保守の引継ぎや追加開発時の増員があったとき、 「新しく参画したメンバーがすぐにシステムを把握するために、どうしたらよいか？」 を考えた際のメモ 背景 問題 新しいメンバーの習熟に時間がかかる 原因 ドキュメントがない・整備されていない 初期構築に関わった人が運用をそのまま実施しており、ドキュメントがなくても困らなかった 新しく人が入ってきて、ようやく気づく 索引がなく、知りたい情報がどこにあるか探すのが大変 今、何が正しいかがすぐにわからない 初期構築時の要件定義書はあるが、追加開発で要件が変わってしまった 追加開発時のドキュメントも全部読まないと何が正しいかがわからない 說明が体系だっていない OJT的な教え方しかできていない 運用や小規模改修から入って、徐々に慣れていってもらうはずが、 枝葉の部分だけ詳しくなってシステムの全容はわからずじまい

[okbm]

ドキュメントの運営大変そう

[efcl]

サーバのドキュメント、構成図の管理。 ドキュメントリポジトリの構造