[PE-D][Tester E] Suggestions for the Developer Guide

AY2425S1-CS2103-F09-1 / tp

MIT License

0 stars 5 forks source link

[PE-D][Tester E] Suggestions for the Developer Guide #301

Closed nus-se-bot closed 2 weeks ago

nus-se-bot commented 2 weeks ago

Right now, the developer guide seems very unpolished and something which was made in a hurry. Missing UML diagrams, inconsistent formatting, incorrect title, etc. I can give you some suggestions from the way we approached our testing guide. I am attaching table of content from our DG. You should take a look and maybe add some more sections to it according to your needs.

Labels: type.DocumentationBug severity.Low original: thisisaditya17/ped#16

somethingfishyfishy commented 2 weeks ago

If we want to add in:

Introduction to NAME OF PRODUCT
How to use this guide
Acknowledgements
Setting up
appendix instructions for manual testing
appendix Planned enhancements
appendix effort

WinstonJin commented 2 weeks ago

Will add in effort, everything else settled