70 likes | 185 Vues
This comprehensive lab report outlines the work and findings from the Databases and Distributed Systems group at Technische Universität Darmstadt. Covering essential aspects like user guidance, design decisions, and implementation details, the report ensures that future developers can effectively extend and utilize the codebase. It also reflects on development history, lessons learned, and offers performance evaluations and benchmarking insights. The document adheres to a structured format to facilitate a logical reading flow, ensuring clarity and coherence throughout.
E N D
MiddlewareLab SS 2008Lab Report Christof Leng, Wesley Terpstra Databases and Distributed Systems Group Department of Computer Science Technische Universität Darmstadt
The Lab Report • To be delivered in two weeks (5.8.2008) • No strict page limit • As long as necessary, as short as possible • ≈15-30 pages in a compact layout • 30% of final grade
Example Table of Contents • Overview • Important(!) top-level overview • User Guide • How to use your code in future projects • Implementation • Design decisions, package descriptions, protocol, libraries • Evaluation • Reflect on what has been learned • Benchmarking / performance evaluation • which abstractions useful / decisions good • Development History • Brief(!) description of progress and problems • Appendix • Scenario definitions, configuration, etc.
Hints • Show mastery of material by discussing what’s important • Language / Style • Use spell-checker • Re-read final text (of other group members too) • Don’t overuse bullet point lists • Structure • Give introductions and overviews • Do not split a single topic between different chapters • Ensure reading flow, keep logical order • Figures • Figures are great, but not every figure is interesting • Figures should match text • Figures should be readable, but not unnecessarily big
Level of Detail • Overview is more important than details • Source level documentation doesn’t belong in the report (it belongs in Javadoc) • Give a good introduction for each chapter • User guide is for future developers • Enable them to use and extend your code • Brief development history • Not every task and problem, but summary
Theses / Hiwi Positions • We offer BSc. / MSc. / Diploma theses topics: • BitZipper Simulation • Integration of Bitzipper in P2P applications • Unstructured Rendezvous (BubbleStorm) • …many more • We have open Hiwi positions (40-80h/month): • P2P programming (Java, C/C++) • Website Development (HTML/XML, PHP)
Thank you • We’re very happy with your work • We hope you also enjoyed it • Your feedback is appreciated: • Anonymous feedback form will be sent by email • Help us to improve the course