Documentation guidelines

Wiki for ITS
ITS wiki WNaS@ITS Master/PhD Courses Master Thesis Research Areas

graphics are always preferred than texts where suitable

If high level specifications are given:

1. describe how you understand it, extend it with your understanding
2. describe how you are going to implement according to the specifications with textual or graphical (preferred) presentation
3. which technologies you are planning to use

If you are given with extensive specification

1. describe how you are going to implement according to the specifications with textual or graphical (preferred) presentation
2. 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)

1. describe rationale
2. describe how you think it should be

if you face challenges

1. describe the challenges you are facing
2. what sorts of support or new knowledge/technologies you need

If you are given with bug

1. provide brief description why it happened and how you gonna solve it (very brief)

When you provide documentation of the codes

1. describe with UML like diagram
2. did you follow reusability and modularity principle if your design - describe briefly these components
3. provide ideas of inter-dependencies between different modules
4. describe briefly functionalities of each modules (if needed copy paste some lines of codes within the descriptions)

Home ITS Wiki WNaS Admin (internal)

Courses Wireless Networks Information Security Rem. Sens./Methods PhD courses

Thesis Open thesis Ongoing Finished

Research Areas Information Security System Security Wireless and Mobile Networks Mobile Services Sensor Systems Radio propagation

Projects DigI: Digital Inclusion Internet Lite for All TrygtSvangerskap IoTSec: IoT Security SCOTT IoT ESA Ka-band GravidPluss

Forms/Wiki Add User Add ActionItem Add Meeting Add Presentation Add Place Edit Wiki Wiki help