nus-cs2103-AY1920S2 / forum

5 stars 0 forks source link

Possible differences in expectations for UG/DG #135

Open zhuhanming opened 4 years ago

zhuhanming commented 4 years ago

Dear Prof/TAs, our team would just like to clarify some questions with regards to the expectations for DG/UG.

We noticed that some of the issues our team received are about possible extensions to the UG/DG e.g. Introduction section to DG, concrete details for UG v2.0 commands, which were not part of the AddressBook 3 documentation. We understand that these suggestions would certainly help to improve the quality of our documentation, but we would just like to clarify if these suggestions would be classified as Documentation Issues.

We're also wondering if this is possibly due to some differences in expectations between CS2103 and CS2103T, since it was previously mentioned that submissions for documentation were required for CS2101, which our team, as part of CS2103, is not taking. As such, our team mainly followed the documentation standards of that of AddressBook 3.

okkhoy commented 4 years ago

All issues suggesting changes to the structure or content of the documentation can be rejected with justification. However, if the suggestion was to use something more appropriate (e.g., sequence diagram in place of activity diagram) then you need to scrutinize it properly before rejecting it. If the teaching team find it was indeed appropriate to use one over the other, we will mark that issue as a valid issue.

WRT UG, as long as the commands are explained (including all options) with examples, it should be good enough. Asking for any more details is considered as a suggestion, and you can reject them.

zhuhanming commented 4 years ago

Ok got it, thanks Prof!