記述したコードがどのように機能するかを説明する
フリーランスのプロジェクトのために、Javaでモノポリーゲームを作成するように依頼されました。それを終えた後、同じ男が私にゲームの仕組みを理解できる4つのUML図を作成するように頼みました。これまではすべてうまくいきましたが、彼の3番目のリクエストで問題が発生しました。
ゲームのコードがどのように機能するかを理解できるように、彼は私に約20〜25ページで書いてほしいと思っています。私は約1年間プログラミングしており、これを行うように要求されたことはありません。これをどこから始めればよいのかもわかりません。コードのどの部分から説明すればよいですか。私は基本的に書くのが苦手です。
必要なものを達成するのに役立つガイドはありますか？ユースケース図のシーケンス図、クラス図、アクティビティ図はすでに作成しました。
あなたのクライアントがあなたに尋ねたのは ソフトウェア設計文書 だと思います。いくつかのガイド here 、 here および here を見つけることができます。
関連する質問は https://stackoverflow.com/questions/708624/what-should-a-good-technical-design-document-contain
あなたが作成した図はビジネスロジックを検証しますが、これは彼らがすでに知っていることなので、これらの図の必要性について質問します。
彼らがあなたの時間の支払いをしていて、あなたがあなたの仕事を25ページで説明できると感じたら、それをやってください。
コードをデバッグして質問のリストを作成するよう依頼することもできます。
また、彼らと一緒に1日を過ごし、自分のしたことを説明することもできます。