CS491B Software Design Lab Writing Project Report Chengyu Sun California State University, Los Angeles.

Slides:

Advertisements

Similar presentations

The Robert Gordon University

Advertisements

Project Proposal.

Theses and Dissertations Structure : How to jam in all that information.

WRITING RESEARCH PAPERS Puvaneswary Murugaiah. INTRODUCTION TO WRITING PAPERS Conducting research is academic activity Research must be original work.

Chapter 12 – Strategies for Effective Written Reports

Writing Skills Improvement Guide Dr. Zubair A. Baig Computer Engineering Department KFUPM, Dhahran.

July 11 th, 2005 Software Engineering with Reusable Components RiSE’s Seminars Sametinger’s book :: Chapters 16, 17 and 18 Fred Durão.

WEBQUEST Let’s Begin TITLE AUTHOR:. Let’s continue Return Home Introduction Task Process Conclusion Evaluation Teacher Page Credits This document should.

Technical Writing II Acknowledgement: –This lecture notes are based on many on-line documents. –I would like to thank these authors who make the documents.

CPRJ2003 Systems Development Group Project

Project Report1 Dave Inman Project report. Project Report2 Ways to write a report Top down: Write the structure of the report (maybe use the web templates.

Lecture 3: Writing the Project Documentation Part I

Advanced Research Methodology

CANKAYA UNIVERSITY FOREIGN LANGUAGES UNIT

Lesson 7 Guide for Software Design Description (SDD)

Report Writing.

Feasibility Study.

Take the University Challenge: Writing in the Sciences The Academic Skills Centre.

1 Literature review. 2 When you may write a literature review As an assignment For a report or thesis (e.g. for senior project) As a graduate student.

Scientific Paper. Elements Title, Abstract, Introduction, Methods and Materials, Results, Discussion, Literature Cited Title, Abstract, Introduction,

MSc project report Q&A session. Outline You should all be focusing on your report now Some guidance on the report structure Q&A session.

Close Reading.  Discuss Model for Text Complexity  Discuss Reader and Task  Define Close Reading  Model a Close Reading Lesson  Create a Close Reading.

Lecture 6: Writing the Project Documentation Part IV.

Preparation of a Research Report Literature review.

Writing Proposals Nayda G. Santiago Capstone CpE Jan 26, 2009.

Design Report – Fall Semester. Title Page List name of project and team number List date List team members, advisor, sponsor Team logos.

Format of Formal Reports

Lecture 1: Introduction – Graduation Projects Topics to Discuss in Lectures 1. Project Deliverables 2. Course grading 3. Project Concept Writing.

Paper Title Authors names Conference and Year Presented by Your Name Date.

Research Methods Technical Writing Thesis Conference/Journal Papers

A SCIENTIFIC PAPER INCLUDES: Introduction: What question was studied and why? Methods: How was the problem studied? Results: What were the findings? and.

SOC09101 Third Year Group Project Unit 6 Project Reporting.

MECHATRONICS Group # Group Members’ Names MENG 483 Project Title of the Project Spring 20XX.

Technical Report Outline Title Page Frontispiece Abstract Table of Contents List of Figures/ List of Tables.

Fall CS-EE 480 Lillevik 480f06-l6 University of Portland School of Engineering Senior Design Lecture 6 Other development processes Technical documents.

SYSTEM ANALYSIS AND DESIGN LAB NARZU TARANNUM(NAT)

Revising Your Paper Paul Lewis With thanks to Mark Weal.

Project Report Format for Final Year Engineering Students.

Guidelines for a Technical Presentation or Poster by Dr. Robert A. Pilgrim Class ID Date Title Author(S) Event/Venue Date.

Technical Writing (Applies to research papers and theses)

Technical Presentation or Poster

REPORT WRITING.

What is technical communication?

Technical Report Writing

How to Read a Paper.

Sample Text for Title of Poster

Writing Scientific Reports

Additional “tidbits” for developing your poster . . .

Writing for Academic Journals

Chapter 18 Formal Reports

Reading and writing reports

Group Name Project Title

TITLE YOUR NAME/DATE Add picture or graphic

Technical Report Writing

The main parts of a dissertation

Final Report Structure

Author of presentation

Preparing Conference Papers (1)

The structure of a Report & the process of writing a Report

Writing reports Wrea Mohammed

Writing an Engineering Report (Formal Reports)

Research Methods Technical Writing Thesis Report Writing

ภาควิชาวิทยาการคอมพิวเตอร์ คณะวิทยาศาสตร์

Project Title Your title should be large enough to read easily, but not so large that you do not have space for the other important sections of the poster.

Preparing Conference Papers (1)

Sample Text for Title of Poster

Sample Text for Title of Poster

Project Closure And Termination

TITLE YOUR NAME/DATE Add picture or graphic

Your Title Your Title Your Name, Your Department Author 1, Author 2.

Presentation transcript:

CS491B Software Design Lab Writing Project Report Chengyu Sun California State University, Los Angeles

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

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

Title Don’t be too generic

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

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

Technological Background Introduce the technologies/tools/platforms you used to build you project Be clear about the connections between the pieces Assume your readers are students who just took CS202 E.g. how do you describe a J2EE project??

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

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..

… 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

System Evaluation Results produced Comparison with other systems Load testing

Conclusion Section Reiterate your achievements Emphasize lessons learned and insights gained

Appendices API documentation Database schema User manual Source code …

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”

Past CS491 Reports All CS491 project reports are available at html 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