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

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

ただいまの
回答率

90.52%

  • PHP

    20339questions

    PHPは、Webサイト構築に特化して開発されたプログラミング言語です。大きな特徴のひとつは、HTMLに直接プログラムを埋め込むことができるという点です。PHPを用いることで、HTMLを動的コンテンツとして出力できます。HTMLがそのままブラウザに表示されるのに対し、PHPプログラムはサーバ側で実行された結果がブラウザに表示されるため、PHPスクリプトは「サーバサイドスクリプト」と呼ばれています。

プログラムの詳細を書くには何がいいでしょうか?

解決済

回答 3

投稿

  • 評価
  • クリップ 2
  • VIEW 304

msx2

score 149

PHPで開発しています。
開発者は私一人だけなので今まではエクセルなどに適当なメモを残しながら作業をしてきました。

開発が進み思いのほか規模が大きくなりプログラムの詳細を覚えていられなくなりました。
プログラムの詳細を後から見てわかるようにするにはどのようなドキュメントを作ればいいのでしょうか?

特に処理をクラスにわけて細かくした辺りから自分でもよくわからなくなっています。
クラス図というのを書いてみましたがクラスの関係はわかりますが流れが表現できません。

流れでいくとシーケンス図かなと思っています。

書き表したいのは、ある1つの機能を実行するための流れです。(機能ごとに図を書こうと思います)

処理をするためにどのクラスを使うのか?そのクラスは何を受け取って保持するのか?どのメソッドを実行するのか?別のクラスを使うのか?別のクラスのどのメソッドを使うか?

といった内容になります。

目的は後から機能を追加したり修正する際にどのクラスを修正したらいいのかを掴むためで、詳細としてはどのメソッドを実行しているかまでです。処理自体の詳細は必要ありません。

もしかしてこういう事は図ではなく詳細設計書などの仕様書に書くのかも知れませんし、プログラム内にコメントを残して分かりやすくするものかも知れません。

一人で開発しているので一般的にどうしているのかが知りたいです。

プログラムの質問でなくて申し訳ありません。
あまりドキュメントに時間を割けないので図で表せたらなと思います。

図で表すべきではない(向いていない)ならそう教えていただければ結構です。
ドンピシャでなくても○○図をベースに書いたらいいよ的な感じで教えて頂ければ自分で調べることもできます。

よろしくお願いします。

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

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

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

    クリップを取り消します

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

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

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

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

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

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

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

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

    質問の評価を下げる

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

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

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

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

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

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

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

    詳細な説明はこちら

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

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

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

回答 3

+1

まずは、UMLのダイアグラムを一通りみて、要望にあうか確認してみてはどうでしょう。
雰囲気的には、コミュニケーション図がよさそうですが・・・

UMLじゃないものもありますが、参考になれば。

https://www.ogis-ri.co.jp/otc/swec/process/am-res/am/index.html

https://www.ogis-ri.co.jp/otc/swec/process/am-res/am/artifacts/index.html

投稿

  • 回答の評価を上げる

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

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

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

  • 回答の評価を下げる

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

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

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

  • 2017/10/21 23:29

    ご回答ありがとうございます。
    返信が遅くなり申し訳ありません。
    アジャイルモデリングは参考になりそうです、確かにコミュニケーション図がイメージに近いですね。
    少しずつ見ていきたいと思います。

    キャンセル

checkベストアンサー

0

どのようなシステムなのか分かりませんが、画面があるものなら画面遷移図だけで充分だと思います。
そのプログラムを実行するトリガーさえ分かれば、だいたい流れは把握できますよね。
webサイトだったらトリガーが画面なので、画面遷移図だけでokというわけです。
クラスが多くなったり継承が深くなった場合でも、IDE使っていれば追えないということはないはずです。
要は「ソースコードがすべて」なのですが、それでもいいようにコード規約を作り、きれいで分かりやすいコードを書く必要があります。
理想を言えば、画面遷移図見ただけでコントローラやモデル、ビュー、サービスなど各クラスを連想できるよう、分かりやすい名前を付けることです。

実際の現場でも設計書より成果物優先ですね。
「どうせ見ないからドキュメントなんていらない」というクライアントさえいます。
いわゆる分かっているクライアントなら、「phpcsでpsr2準拠にしてくれ」とか「phpmd通してくれ」などと具体的な指示を出す場合もあります。
最近はテストもテストケースのファイルだけでokな案件も増えてきました。
金融系の案件でない限り、ドキュメントに固執するクライアントはいません。

ご自身で作られたシステムなら大雑把な流れは把握してますよね?
だったら、いかに文書として残すかを考えるより、いかに分かりやすいコードを書くかに注力すべきではないでしょうか。

投稿

  • 回答の評価を上げる

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

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

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

  • 回答の評価を下げる

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

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

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

  • 2017/10/21 23:45

    ご回答ありがとうございます。
    返信が遅くなり申し訳ありません。

    きっとこの回答があるべき姿なんだと思います。
    プログラミングが独学のため行き当たりばったり(とにかく動くものをつくるため)でソースを書いているために後からクラス名やメソッド名を見ても何をやっているのかわからないんです。要するにスキル不足なのですが。。
    それを補おうと図で表したいと考えた訳ですが、わかりやすい名前とコメントでわかるようにするスキルを磨いていくべきですね。

    指導してくれるメンターや参考になるソースを目にする機会もないので泥臭いやり方でもいいのでどうにかメンテナンスできる状態に持っていければと思います。

    少しずつでもきれいで分かりやすいコードが書けるように努力しようと思います。
    とても参考になりました、アドバイスありがとうございました。

    キャンセル

0

質問を読むに用途としては自分用ですよね。
ソースコードのdocコメント拡充で十分だと思います。
それ以前にファイル名だけで何の機能なのかアタリが付くように、命名規約、コーディング規約に時間をかけると良いです。

図は描いてもフローチャートと画面遷移図くらい?
設計書とか○○図はお客さんとか他の人に見せる必要があるなら書くかな。

投稿

  • 回答の評価を上げる

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

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

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

  • 回答の評価を下げる

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

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

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

  • 2017/10/21 23:53

    ご回答ありがとうございます。

    命名規約やコーディング規約がしっかりできていて守られていれば名前をみれば機能などのアタリがつくということですよね。
    本業の開発現場ではそれが当然であって開発者に求められるスキルだと思います。

    私はそういったスキルが不足しているために今回の質問をしましたが、後からソースコードとコメントを見ればわかるようにしたいと思います。

    状況が許せばどこかの現場にお金を払ってでも修行にいこうかと本気で考えている今日この頃です。。

    キャンセル

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

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

関連した質問

  • 解決済

    クラスのフィールドとメソッド一覧を取得したい

    javaで開発を進めています。 あるクラスのフィールドとメソッドの一覧を抽出するプログラムを作成したいのですが、どういった方法があるでしょうか? また、継承関係にある親クラスのフィ

  • 受付中

    java inputstream outputstream

    java初心者です。 Socket、ServerSocketを利用したデータの送受信を行えるプログラムを作成しています。 その中でinputstreamやoutputstream

  • 受付中

    pythonのクラス コンストラクタについて

    初期化メソッドはクラスのインスタンスがつくられると呼び出される。 クラス変数はすべてのインスタンスで共通の変数であること。 クラス変数をクラス内で書く、もしくはクラスの外部からクラ

  • 受付中

    property()について

    class Hoge: def __init__(self, a, b): self.__a = a self.b = b @pr

  • 受付中

    ダイアログ表示

    前提・実現したいこと javaプログラムでmainの中のHelloの出力をダイアログボックスで出したいです。 試したことにあるプログラムはmainが使われているので困っています

  • 解決済

    JavaのThreadについて

    JavaのThreadについての非常に簡単なコードなのですが、なぜだか実行することができずに困っております。 public class Main { public v

  • 解決済

    Object.class、Class.classとはなんでしょうか?

    前提・実現したいこと Java初心者です。 現在勉強の最中なのですが、以下のようなコードが出てきて困っています。 これは一体何を目的とした判定なのでしょうか? またどういう

  • 解決済

    Visual Studioでのデバック方法について

    OS:Windows7Sp1 VisualStudio2017community 言語:VisualBasic.NET Try ~ Catch ~ Finall

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

  • PHP

    20339questions

    PHPは、Webサイト構築に特化して開発されたプログラミング言語です。大きな特徴のひとつは、HTMLに直接プログラムを埋め込むことができるという点です。PHPを用いることで、HTMLを動的コンテンツとして出力できます。HTMLがそのままブラウザに表示されるのに対し、PHPプログラムはサーバ側で実行された結果がブラウザに表示されるため、PHPスクリプトは「サーバサイドスクリプト」と呼ばれています。