文書を手渡すための最良の方法は何ですか？

Question

5年後に会社を離れる開発者がいて、長年にわたって文書化を拒否していた多くの有用な情報を取得し、経営陣は基本的に彼の気まぐれに気づきました。

私たちは、彼が行く前に数週間開発者を抱えており、彼が文書化する必要があることがわかっている領域があります。しかし、私たちが彼自身を文書化する必要があるかどうかは確かではありません（恐れて、彼は4週間以内に標準的な文書を作成するでしょう）か、あるいは何人かの開発者に彼と一緒に座らせて、開発者に文書化する責任。これは他の開発者から時間がかかるので理想的ではありません。

どのようにアジャイルハウスがこれに対処しますか？

Answer 1

「コーナー」に書かれた「もの」の割り当てを避けることは避けてください。単純な理由で、彼は低品質の出力を生成する危険性があります。

コードベースの文書化されていないキーパーソンの所有者である場合、これはチームの最優先課題として扱われるべきです。
1日中少なくとも2人の人が彼と交互に（交互に）会ったことがあります。 1人の開発者が直接あなたの残し同僚に従事している時には、（s）は、他のは、彼らが「あなたの社内準拠培地中で自分の順番（インラインコメント、ウィキ、ドキュメント...）中に学習ましものをドキュメント化する必要があります。
あなたの退職している同僚が、技術的にできるだけ対処できる&の好きな人を選んでください。
私は、すべての仕事があなたの同僚の机の上で行われるのが最善だと思います。

あなたは「再欠落しているものを知っているように見えるので、あなたのターゲットについても計画することができます - 可能な限り正確に。最初に堅い部分をカバーするようにしてください。離職者&とこの計画について話し合ってください。全く

避けては緊張&はあなたのままに男がリスクへの唯一の悪い勧告を持っていることを覚えてかかります。

Answer 2

通常、この種の移行は広範なコードレビューによって行いますが、通常は期間があなたと同じ（5年）のケースはありません。標準的なプラクティスとして、毎週コードレビューを行い、その間にコードコメントとして、またはドキュメントリポジトリ内の外部ドキュメントを参照する必要がある場合は、コード自体にドキュメンテーションを追加することをお勧めします。定期的にレビューを行うことで（通常、週次の開発計画の最後に）、プロジェクトの途中で私たちを退去させた場合に、適切な文書がなくても影響が最小限に抑えられます。

5年は長い間ですが、誰かが座ってレビューした内容を確認して正しくコメントアウトすると、自動化されたドキュメント（JavaのJavaDocなど）が作成される可能性があります。彼と一緒に座っている開発者が特定の詳細を忘れる可能性があるので、コードレビューをリアルタイムでやっているのではなく、より長い時間を使用したくないので、ドキュメンテーションをリアルタイムでやっている方がよいでしょう。後で文書化してください）。

コードの音量によっては、レビューする必要があるコンポーネントを選択して選択する必要があります。開発者は、どのコンポーネントが最も重要であるか（コアアルゴリズムなど）に優先順位を付けることができ、そこから適切なグループでレビューを開始する必要があります。

また、社内にwikiがある場合は、その中にエントリを追加してコードドキュメント自体から参照することができます。

Answer 3

彼は、

正しいを行っていたものを説明しているように、いくつかの開発者は、彼と一緒に座ってもらいます。他の方法はほとんどありません。

豊富なペアプログラミング、コードレビュー、ウォッチ＆ラーニングです。これは他の開発者

からの時間を占めるよう

理想的なない、あなたは情報をしたいですか？もしそうなら、あなたはそれを集めるために時間を費やさなければなりません。

そうでない場合は、心配しないでください。