Documentation guidelines
From its-wiki.no
Wiki for ITS | ||||||
---|---|---|---|---|---|---|
|
![]() |
graphics are always preferred than texts where suitable
If high level specifications are given:
- describe how you understand it, extend it with your understanding
- describe how you are going to implement according to the specifications with textual or graphical (preferred) presentation
- which technologies you are planning to use
If you are given with extensive specification
- describe how you are going to implement according to the specifications with textual or graphical (preferred) presentation
- which technologies you are planning to use
if you want to provide suggestions from your own (based on the any design or high level specifications)
- describe rationale
- describe how you think it should be
if you face challenges
- describe the challenges you are facing
- what sorts of support or new knowledge/technologies you need
If you are given with bug
- provide brief description why it happened and how you gonna solve it (very brief)
When you provide documentation of the codes
- describe with UML like diagram
- did you follow reusability and modularity principle if your design - describe briefly these components
- provide ideas of inter-dependencies between different modules
- describe briefly functionalities of each modules (if needed copy paste some lines of codes within the descriptions)