1 / 16

CS491A Software Design Lab Writing Project Report

This project report provides an outline for writing a comprehensive project report for software design and implementation projects. It covers the essential components such as abstract, introduction, technological background, system overview, design and implementation, system evaluation, conclusion, and appendices.

vossr
Télécharger la présentation

CS491A Software Design Lab Writing Project Report

An Image/Link below is provided (as is) to download presentation Download Policy: Content on the Website is provided to you AS IS for your information and personal use and may not be sold / licensed / shared on other websites without getting consent from its author. Content is provided to you AS IS for your information and personal use only. Download presentation by click this link. While downloading, if for some reason you are not able to download a presentation, the publisher may have deleted the file from their server. During download, if you can't get a presentation, the file might be deleted by the publisher.

E N D

Presentation Transcript

  1. CS491A Software Design LabWriting Project Report Chengyu Sun California State University, Los Angeles

  2. Outline of a Project Report Title Technological background System/Application Projects Author System overview Abstract Design and implementation of each component Introduction System evaluation Content Theoretical background Theory/Algorithm Projects Theorem / algorithm descriptions Conclusion References Proofs / Implementation Appendices Performance evaluation

  3. What is a Project Report? • Project report != documentation • A project report should tell • What is your project? • Why did you choose the project? • How did you conduct the project? • What are the results/products/lessons of the project? • A way to evaluate your technical writing skills

  4. Title • Don’t be too generic

  5. Abstract • Tell the whole story in 100 to 200 words • A good abstract • Let people know you’ve done good work • Make people want to read more

  6. Introduction Section • A more elaborated version of the abstract • Focuses on • Motivation • Project highlights

  7. Technological Background • Introduce the tools/libraries/platforms you used to build you project • The purpose is to help people understand your project, i.e. not advertisement for the technologies • Assume your readers are students who just took CS202 • Be clear about the connections between different pieces

  8. System Overview • The Big Picture of your project • Descriptions of the interaction between different components, overall work flow etc.

  9. Design and Implementation … • Design (or feature design), is how things should be • E.g. The system support several types of users … • Implementation is how things are done • E.g. Each user type is implemented as a subclass of a User class ..

  10. … Design and Implementation • Writing about design and implementation is not easy • Choose the right level of details • Topics that are usually interesting and/or important • Performance • Security • Improvement of user experience • Insights, insights, insights

  11. System Evaluation • Results produced • Comparison with other systems • Load testing

  12. Conclusion Section • Reiterate your achievements • Emphasize lessons learned and insights gained

  13. Appendices • API documentation • Database schema • User manual • Source code • …

  14. Some Technical Writing Do’s and Don’ts • Use formal language • Use diagrams and figures • Use tables • Don’t overuse pictures and screenshots • Don’t overuse bullets • Don’t overuse passive voice • Use “We” instead of “I”

  15. Past CS491 Reports • All CS491 project reports are available at http://cs.calstatela.edu/abet/cs491/index.html • Some good reports • Matthew’s ProgFest 2005 Platform • Chris’s Deep Space 2 • Andrew's CodeSimian • Cheralyn's Cupboard 2.0 • Christopher's LemGen • Kelly's Content-based Image Organization

  16. More Good Reports • Andres’s 3D Surface Explorer • Eugene’s Project Black Widow

More Related