nus-cs2103-AY2223S2 / forum

12 stars 0 forks source link

How much details to give in DG #311

Open damithc opened 1 year ago

damithc commented 1 year ago

[posting on behalf of a student]

Also, how in-depth must our DG implementation be? Must we create activity and sequence diagrams for every command? or is it ok to limit it to "noteworthy" features?

Yes, OK to omit less important things. Think from the target reader's (i.e., a future developer) point of view and make a judgement call on what to include and how much details to give. In general, documentation should be minimal but sufficient. Also refer our DG tips. In some cases, OK to give a little bit more than the 'minimal' details in order to showcase your ability to use various diagram types effectively.