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

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

旧館より 考え方

文書化の指針

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


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

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

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

ただそれ以外では…

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

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

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

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

Photo via VisualHunt

-旧館より, 考え方

執筆者:


comment

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

関連記事

「従業員」満足度調査

本人が望む、望まないは別として「顧客満足度調査」等のようなアンケートに答えたことが1回はあると思います。 その兄弟で「従業員満足度調査」なるものがあります。 「自分の会社にどれほど満足しているか1~5 …

「感謝の言葉を伝える」アクティビティ

少し前、グループでフリカエリとこれからの活動について、半日時間を取って、しっかり議論しました。 夜は、(それまでの活動が一区切り付いたこともあって)打ち上げをしたのですが、そこでちょっとしたアクティビ …

「ホウレンソウ」のレベル

先月…7月初旬から新人が配属になりました(それまでは3ヶ月の集合研修)。 それをきっかけにして、ふと過去に新人のOJT担当だった時に書き留めていたメモを書いてみます。 「ホウレンソウ」…報告・連絡・相 …

ペアプログラミング―エンジニアとしての指南書[読書感想]

ペアプログラミング―エンジニアとしての指南書 著者:Laurie Williams, Robert Kessler 翻訳:長瀬 嘉秀, 今野 睦, テクノロジックアート 今の小規模プロジェクトで、ペア …

Share

インセプションデッキを書いてみた

社内で「アジャイルサムライ~達人開発者への道~」の読書会をやっています この読書会。色々な所(道場)があります。詳しくはGitHubにまとめられているWikiをご覧ください。 読書会で作ってみた その …

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