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

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

旧館より 考え方

文書化の指針

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


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

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

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

ただそれ以外では…

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

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

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

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

Photo via VisualHunt

-旧館より, 考え方

執筆者:


comment

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

関連記事

情報の欠如

仕事柄、(全てが等価値で無い)いくつもの情報から判断を必要とすることがあります。 もちろん、上司も私以上の無数の有形無形の情報から判断しています。 役職や立場が上になればなるほど、情報がたくさん入って …

1回の会議・打ち合わせで必ず結論を出す技術[読書感想]

1回の会議・打ち合わせで必ず結論を出す技術 著者:斎藤 岳 題名の通り、会議/打合せでいかに(参加者全員が納得し、次のアクションへつながる)結論を出すかを書いています。 ◆目次 第1章 「結論を出す能 …

「モチベーションの源泉:何のために働くのか、転職か起業か」を読んでみて

@kuranukiさんの「モチベーションの源泉:何のために働くのか、転職か起業か」(「Social Change!」より)を読んで… 「サポータータイプ」:7「クラフトマンタイプ」:3かな、私は。RT …

自己紹介の目的

#参考記事:「自己紹介で確実に名前を覚えてもらう方法」@誠 Biz.ID 自分なりに考えてみると…「自己紹介を通じてこの人(=された側にとっては新しく知った人)は自分にとってどのように影響を与えてくれ …

Javaの格言―より良いオブジェクト設計のためのパターンと定石[読書感想]

仕事でJavaを使ってのシステム構築をしています。 勉強したり、資格を取るためJavaをさわることはあっても仕事は初めてです。 で、思い立って以前に買って積読していた↓をちゃんと読んでみました。 ■( …

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