search

kaiyichen / pe

0 stars 0 forks source link

Developer guide is too long and complicated #23

Open kaiyichen opened 2 years ago

kaiyichen commented 2 years ago

Developer guide can be shorten as some parts are repetitive and and be omitted. It will be easier for readers to read

soc-se-bot commented 2 years ago

Team's Response

Hello, each component of our DG should be comprehensive and detailed to aid the developer with his understanding. Each thing we included in the DG does not overlap with one another and they serve a purpose. Furthermore, your response is very vague and we cannot identify which part you are referring to. What is too long? What is complicated? What could be shorten?

From the CS2103 website, it is stated that "If the readers are developers who will eventually read the code, the documentation should complement the code and should provide only just enough guidance to get started".

Our DG also consists of a Table of Content and hyperlinks to bring you around the DG so that you can jump to specific parts. We have included diagrams and examples so that it is easier to understand. I hope you can appreciate that we took the time to explain how our application come to be!

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: [replace this with your explanation]