General guidelines for the project documentation ------------------------------------------------ The project has a mandatory project plan (DL 11.3.) and two iteration rounds (DLs 3.4. and 28.4.). Project plan is graded as passed/failed. These instructions are about the documentation related to the iterations, not about the project plan. For each iteration you should deliver the source code and corresponding documentation. Documentation includes at least: - Compilation and running instructions - How the features are implemented: what exactly is changed - Where and how the system is tested (give an environment in Niksula) - List of known bugs and problems - Time management control: compare the time used to your estimation in project plan - In addition the documentation for the first iteration should include: - A short evaluation about the team work: - did you follow the practices of you project plan / how you liked those practices - are you going to change anything in your team work for the second iteration Correspondingly the documentation for the second iteration should include: - Did you encounter any cases where implementing different features required editing the same file by different people at the same time? How did you solve these problems? - A reflection what you have learned during the project. For example: - Time management: if your estimation was not correct, can you identify the reasons for that? - Team work: did you have any problems and how would you change you working practices? - Implementation, design and testing: How your group performed with these? Did you have any problems?