質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

ただいまの
回答率

88.23%

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

解決済

回答 2

投稿

  • 評価
  • クリップ 1
  • VIEW 1,251

arare000

score 26

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

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

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

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

  • 気になる質問をクリップする

    クリップした質問は、後からいつでもマイページで確認できます。

    またクリップした質問に回答があった際、通知やメールを受け取ることができます。

    クリップを取り消します

  • 良い質問の評価を上げる

    以下のような質問は評価を上げましょう

    • 質問内容が明確
    • 自分も答えを知りたい
    • 質問者以外のユーザにも役立つ

    評価が高い質問は、TOPページの「注目」タブのフィードに表示されやすくなります。

    質問の評価を上げたことを取り消します

  • 評価を下げられる数の上限に達しました

    評価を下げることができません

    • 1日5回まで評価を下げられます
    • 1日に1ユーザに対して2回まで評価を下げられます

    質問の評価を下げる

    teratailでは下記のような質問を「具体的に困っていることがない質問」、「サイトポリシーに違反する質問」と定義し、推奨していません。

    • プログラミングに関係のない質問
    • やってほしいことだけを記載した丸投げの質問
    • 問題・課題が含まれていない質問
    • 意図的に内容が抹消された質問
    • 過去に投稿した質問と同じ内容の質問
    • 広告と受け取られるような投稿

    評価が下がると、TOPページの「アクティブ」「注目」タブのフィードに表示されにくくなります。

    質問の評価を下げたことを取り消します

    この機能は開放されていません

    評価を下げる条件を満たしてません

    評価を下げる理由を選択してください

    詳細な説明はこちら

    上記に当てはまらず、質問内容が明確になっていない質問には「情報の追加・修正依頼」機能からコメントをしてください。

    質問の評価を下げる機能の利用条件

    この機能を利用するためには、以下の事項を行う必要があります。

質問への追記・修正、ベストアンサー選択の依頼

  • 退会済みユーザー

    2016/12/06 17:34

    こちらの質問が他のユーザから「プログラミングに関係がない質問」という指摘を受けました
    teratailでは、プログラミングに関して困っていることがないと思われる質問を推奨していません。
    「質問を編集する」ボタンから編集を行い、具体的に困っている理由や解決したいことを明確に記入していただくと、回答が得られやすくなります。

回答 2

checkベストアンサー

+4

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

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

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

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

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

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

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

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

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

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

+2

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

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

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

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

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

15分調べてもわからないことは、teratailで質問しよう!

  • ただいまの回答率 88.23%
  • 質問をまとめることで、思考を整理して素早く解決
  • テンプレート機能で、簡単に質問をまとめられる

関連した質問

同じタグがついた質問を見る