web-dev-qa-db-ja.com

プロジェクトが凍結しました-私の後の人々に何を残すべきですか?

そのため、私が取り組んできたプロジェクトは、無期限に凍結されることになります。プロジェクトが再びフリーズ解除されると、私または現在のチームの誰にも割り当てられない可能性があります。実際、プロジェクトは凍結前に引き継がれましたが、プロジェクトの基本的なニーズさえ理解するのに役立つ前のチームからの情報がなかったため、プロジェクトをよく理解するために多くの時間を費やしました。私の質問は、私たちの後の人々がプロジェクトのニーズを最もよく理解できるようにするために何をすべきだと思いますか、私たちが何をしたのか、なぜそれを行ったのかなどです。このプロジェクトでも機能する他のトラックをいくつか紹介します。

すでに実行したいくつかの手順:

  • 技術文書(完全ではありませんが、少なくともいくつかはあります);
  • ソース管理システムの履歴。
  • プロジェクトのどの部分に改善が必要であるか、そして私たちがそう考える理由についての推定。
  • ユニットテストの束。
  • 行ったすべてのチケットを発行したトラッカーを発行します([〜#〜] edit [〜#〜]

私たちがすでに準備していること、そして他に何ができるかについてどう思いますか?

14
nyxz

考慮すべきいくつかのこと

  • プロジェクトのディレクトリ構造は正気ですか?コードのコメントを修正しましたか?コミットログは何らかの形で提示できますか?
  • Gerneral目的の概要(開始した技術的ではなく)、プロジェクトに関する推奨読書、プロジェクト履歴(その開発サイクル、以前のプロジェクトマネージャー、スタッフのリスト、要件/機能仕様)
  • UML図、クラス図、ワークフロー図!
  • プロジェクトが凍結された理由は常にいいです。
  • 開発環境、使用されたIDE、ビルドツール、これらはテクニカルドキュメントでカバーされていますか?

最近受け継いだプロジェクトで見たかったことをいくつか考えただけです。あなたがすでに提供したものは、私が得たものよりもはるかに多くの地獄です。次のチームを支援するための主要なカルマポイントを受け取ります:)

9
lwm

他の誰かが下したプロジェクトを取り上げるときに私がしたいことは次のとおりです。

ツールチェーン内のすべてのツールの最新の既知の動作バージョンを含むビルド手順。コンパイラ、IDEなどは時間とともに変化します。以前の開発者が立ち上げて実行する方法についての指示を残しておくと、作業がはるかに簡単になります。

実行環境の説明-これを実行するために必要なものは何ですか?どのバージョンの説明も役立ちます。私は最近、特定のファイルセットを特定の場所に置く必要があるものを拾いました。それを理解するために他の開発者にクイズを出さなければなりませんでした。他の開発者が利用可能になったので大したことではありませんが、もしそうでなければ、問題があったでしょう。

リポジトリにコミットされたコードが実際にチェックアウトとビルドを行うことを保証します。以前の開発者(幸運にもまだ)がMakefileで本当に奇妙なことを行っていて、クリーンなチェックアウトからプロジェクトをビルドできないプロジェクトをかつて私はピックアップしました。言うまでもなく、実際に作業を行う前に、まずそれを修正する必要がありました。以前の開発者が利用できなかった場合、そのハードルを乗り越えるのにはるかに長い時間がかかった可能性があります。

プロジェクトの意図の一般的な声明。このソフトウェアは何のためのものですか?合理的には短いですが、ある種の概要は本当に役に立ちます。

8
Michael Kohne

スクリーンキャスト

私が最後の仕事を辞めたとき、私は実際に編集されていないスクリーンキャストをしました、そしてそれは私が聞いたことから、新しい人々をオンボーディングするのに非常に役に立ちました。私はチームを部屋に連れて行き、コンデンサーマイクを設置して、オーディオと画面を録音しながらプロジェクトについて知っているすべてを説明しました。それから私は彼らに私にそれについて質問をさせました。座って、一日中できるだけ早くタイプしようとした場合よりも、はるかに多くの情報を記録することができました。

4
Ryan Hayes

情報に精通している場合は、ビジネス要件を追加してください。

  1. お客様は何を望んでいましたか?
  2. 変更はそれをどのように促進しましたか?
  3. 顧客のニーズを満たす上での課題は何ですか、またはいくつかありますか?
  4. 満たされていないニーズとその理由
2
Menefee

実行中のスタンドアロンの開発システムの仮想マシンイメージ(つまり、vm-ware)は非常に価値があります。

昨年、いくつかのvb3コードを修正するように依頼されました。 vb3、windows95、および多数のインストールされているole-controllsを使用して実行中のシステムを再作成することは非常に困難でした。一週間後、私はあきらめました:-(

[更新] 新しい仮想マシンプレーヤーで再生できるように、古い仮想マシンイメージを変換する経験はありますか?

また、最新のハードウェア/ゲストOSで非常に古いイメージを実行することができなくなる可能性があることも考慮する必要があります。

1
k3b