独自のPHPフレームワークの引継ぎ方法

Question

業者にWebサイト（コミュニティサイト）を、手組を条件に委託しているのですが、後になってPHPの独自フレームワークを使っていることが判明しました。サイトはHTML,PHP、Javascript、SQLで作っているそうです。

委託後に第三者が引き継いでサイトを拡張できるように、納品時に独自フレームワークの内容が分かるようにしておきたいのですが、話を聞いたところ、自社で使っているので、特段第三者向けのドキュメントなどは何も用意していないとのことでした。

仕方ないので何か資料を作ってもらうようにその業者に依頼しようと思うのですが、どういった依頼すれば最も最低限引き継げるようになるでしょうか？

納品をしてもらえれば、一切ドキュメントがなくてもわかる人には問題なく理解できるものなのでしょうか。

Answer 1

自分が思いつく限りですが、

=== 最低限 ===
■現在存在する開発ドキュメント全て（第三者向けなどは関係なく）

■フレームワークを使用した場合の１画面の作成手順
※検索画面を作る場合が良いと思います。（初期表示⇒検索リクエスト⇒ＤＢアクセス⇒再表示の流れがある為）

■独自フレームワークの全モジュール一覧（説明なしで、どのファイルが最初に動作するかだけ）
※フレームワークと業務ロジックを区別する為

■ビジネスロジックないで使用する共通クラス、共通関数一覧

=== あるとうれしい（ないと解析により時間がかかる） ===
■クラス図

■独自フレームワークの全モジュールの解説
（モジュール単位の説明も含む※クラスレベルではなく関数レベル）
※最低でもフレームワークとそれ以外のモジュールが判別できるレベル

納品をしてもらえれば、一切ドキュメントがなくてもわかる人には問題なく理解できるものなのでしょうか。

できるかできないかで言えば、最初に動くPHPさえ分かれば解析はできますが、
膨大な解析の工数が発生します。
PHPが読める、書けるレベルでは無理だと思います。
PHPをそこそこ理解していないと、通常のビジネスロジックでは書かないような関数や処理が存在すると思います。
※無名関数、マジックメソッド等々

Answer 2

まずはコードをもらいましょう。
それを社内の有識者で見て、不明な点をドキュメントとして作ってもらうのが最低限のレベルかと思います。

本来なら、
・どういった仕組みなのか（仕様書）
・ファイル構成や関数仕様など（設計書）
・使い方（運用マニュアル）
などは欲しいところです。

納品をしてもらえれば、一切ドキュメントがなくてもわかる人には問題なく理解できるものなのでしょうか。

コードを見てみないことにはなんとも言えないでしょう。
コード自体の作り方もありますし、適切なコメントがあるかどうかでもかなり違います。