サウスポーなエンジニアの独り言

サウスポーなエンジニアが日々感じた、気づいた、学んだことを徒然と書いています。

旧館より 考え方

文書化の指針

投稿日:2008年3月21日 更新日:


以前の「未来の自分を信頼し過ぎない」ことを書きました。

とはいうものの、何でもかんでもドキュメント化するのではなく、いくつかの要因(例として必要度合い)から判断して作るか決めれば…とも書きました。
私は、その判断基準に一つに「(その事柄について)何度聞かれたか?」という点があります。

例えば、プログラムの実装方針(Sessionの持ち方等)や、よくあるのが開発環境構築の際の細かい設定やDBへの接続文字列やサーバへのリモート接続の方法等です。
例に挙げた実装方針などはアプリケーション自体の品質にかかわりますので、よく検討した上、明文化され、プロジェクト間で共有できているのが当たり前ではあります。

ただそれ以外では…

A:「サーバへの接続文字列なんでしたっけ?」
リーダー:「パスワードはXYZやで」
A:「あ、分かりました。(接続して作業する)」
 …で、また数日後…
C:「サーバへの接続文字列なんでしたっけ?」
リーダー:「パスワードはXYZやで」

…となることが多いように思います。

同じ質問を別の人からされたのであれば、N人にとって必要だったわけです。
そして、今後も(未来の自分も含めて)質問されると思うのが妥当という判断をして、ドキュメント化したりWikiにしたりするわけです。

※注意:この記事は旧サウスポーなエンジニアの独り言から移行し一部修正したエントリです。

Photo via VisualHunt

-旧館より, 考え方

執筆者:


comment

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です

関連記事

えらくなっていきたいか?

ずいぶん前に書いたまま放置していたのを(ちょっと書き足して)アップします。 組織において「えらくなっていきたいか?」という話です。 えらくなりたいか?の問いに対して 一時期「昇格/昇級したいか?」とい …

UltimateAgileStories1で書いた内容

最近、UltimateAgileStories Iteration2(UAS2)のエントリ([雑多]UltimateAgileStories Iteration2が届きました)を書きましたが、その1冊 …

プロジェクトにおける「割れ窓理論」

環境犯罪学上の理論に「割れ窓理論」というのがあります。 「建物の窓が壊れているのを放置すると、誰も注意を払っていないという象徴になり、やがて他の窓もまもなく全て壊される」(Wikipediaより) 有 …

聖人君子はムリでも…

街中で見かけた光景で、ふと思ったことです。 車通りも滅多にない幅の狭い道路、でも信号と横断歩道はあります。 さて、徒歩or自転車でその道路を渡ろうとします(車は影も形もありません)。 が、横断歩道の信 …

変更履歴を論理的に見ておかしいと思わないのは…

仕事での行動基準…うまく言えないのですが「これを気をつけて欲しいなぁ」的な内容…を考えることがありました。 SEが作成するドキュメント(堅く言うと「成果物」)にはたいがい「変更履歴」を記入する欄があり …

ギルドワークスの現場コーチ。
「正しいものを正しくつくる現場を増やす」ことを目指している現場コーチ。認定スクラムマスター(CSM)。
様々な規模のSIerでのシステム開発を経て今に至る。
DevLOVE関西を主催。