Documenting Robot Project Work

  • View
    214

  • Download
    0

Embed Size (px)

Transcript

  • 8/3/2019 Documenting Robot Project Work

    1/7

    REPUBLIC OF KENYAMINISTRY OF HIGHER EDUCATION

    SCIENCE AND TECHNOLOGY

    DOCUMENTING ROBOT

    PROJECT WORK

    Guideline on the Structure of the Report

    4/17/2009

    MOHEST

    DIRECTORATE OF TECHNICAL EDUCATION

  • 8/3/2019 Documenting Robot Project Work

    2/7

    Format for Documentation of Robot Development Page 2

    Table of Contents

    INTRODUCTION ................................................................................................................................ 3

    2.0 REPORT FORMAT .................................................................................................................... 3

    2.1 FRONT PAGES ..................................................................................................................... 3

    2.1.1 Cover Page .................................................................................................................. 4

    2.1.2 Table of Contents ....................................................................................................... 4

    2.1.3 List of Figures.............................................................................................................. 4

    2.1.4 List of Tables ............................................................................................................... 4

    2.2 MAJOR SECTIONS ............................................................................................................... 5

    1.0 Introduction:................................................................................................................... 5

    2.0 Robot Construction ........................................................................................................ 5

    3.0 Design Specification ....................................................................................................... 6

    4.0 Design Process ................................................................................................................ 6

    Performance Results and Discussion ..................................................................................... 6

    6.0 Conclusion ...................................................................................................................... 7

    7.0 Recommendations ......................................................................................................... 7

    2.3 END PAGES.......................................................................................................................... 7

    2.3.1 Reference ........................................................................................................................ 7

    2.3.2 Appendices...................................................................................................................... 7

  • 8/3/2019 Documenting Robot Project Work

    3/7

    Format for Documentation of Robot Development Page 3

    INTRODUCTION

    The robot construction team is responsible for composing a single group report that

    describes in detail the robot design. This is because the group is acting as a sub-team

    within a larger design team and therefore, the intended audience for the report is the

    larger design team. The audience of this report is judges, referees and other

    stakeholders therefore the tone should be formal.

    The goal is to convey the results of your performance analysis, prototype testing (i.e.

    component test results), and recommendations for the robot machine that you have

    designed. The usual standard for preparing such report is that the reader should be

    able to reproduce your analysis and testing, and build the final design, without having to

    ask any questions.

    The two main purposes for writing this report are to:

    1. Document your robot design and2. Demonstrate improved report writing skills.

    2.0 REPORT FORMAT

    The technical report should be a professional document with graphs, tables, and

    drawings used to clarify the text. The three main parts of a technical report are shown

    below in Figure 1:

    Figure 1. Three Main Sections of a Final Report

    2.1 FRONT PAGES

    The front pages include (i) the Cover Page; (ii) Table of Contents; (iii) List of Figures;

    and (iv) List of Tables. The page numbers are Roman (e.g., i, ii, iii, etc.) and there are no

    I. Front Pages

    ii, iii, iv

    II. Major Sections

    1, 2, 3, 4..

    III. End Pages

    9, 10, 11..

    (References)

    A1, A2, B1, B2

    (Appendixes)

  • 8/3/2019 Documenting Robot Project Work

    4/7

    Format for Documentation of Robot Development Page 4

    numbers on the cover page (although it is considered the first page). The following is a

    sample of the front pages (Figure 2):

    Figure 2: Sample Front Pages

    2.1.1 Cover Page

    The first page of the technical report should be unnumbered and should include:

    Design to Specification Report (name of the report) Group Number: Names of all your group members: Date:

    Each item should be centered and separated by enough space to fill the whole page and

    give the cover page a good appearance. The group number is to discriminate the groups

    from the same institution or organization that present robots for the competition.

    2.1.2 Table of Contents

    This is a listing of the major sections in the report and the page numbers on which they

    begin. The table of contents should not list itself but should include the page numbers

    of the major sections and appendixes in the report,

    2.1.3 List of Figures

    This is a list of all of the figures in your report and the page numbers on which they are

    found. This section should be omitted if the report has less than three figures.

    2.1.4 List of Tables

    This is a list of all of the tables in your report and the page numbers on which they are

    found. Do not include this section unless you have at least three tables in your report.

    Cover Page Table of ContentsList of Figures

    ivList of Tables

    .v

    Executive Su1

    Introduction.2

    (list othersections)

    List of Figures

    Fig. 1. Graph3

    Fig. 2 Proto..6Fig. 3. F inal..7

    List of Tables

    Table 1. Wt..2

    Table 2. Memb5Table 3. Cost8

  • 8/3/2019 Documenting Robot Project Work

    5/7

    Format for Documentation of Robot Development Page 5

    2.2 MAJOR SECTIONS

    This is the main part of the technical report and the pages are numbered in Arabic (e.g.,

    1, 2, 3, 4, etc.) beginning with one. This section should include the Executive Summary

    that gives a summary of the details in the report. It can be taken as an abstract of the

    entire robot development process. Figure 3 shows how this section should be organized

    Figure 3: Sample Major Sections

    The major subsections in the report include (i) Introduction; (ii) Robot Construction

    (iii) Design Specification; (iv) Design Process; (v) Performance analysis and Discussion;

    (vi) Conclusion and (vii) Recommendations.

    1.0 Introduction:

    This section outlines the parameters of the project, or in other words, the problem

    definition. Additionally, it addresses the project purpose and what you hope to

    accomplish. After reading this section, the reader should know in broad terms what

    your team was trying to do and your goals. At the end, briefly outline how the report is

    organized (e.g. In this report, the following sections will be discussed.).

    2.0 Robot Construction

    Figure 4: Multi-view Layout

    Executive Summary

    1

    1.0 Introd

    Xxxxxxxxxxxxxxxxxx

    xxxxxxxxxx

    2.0 Proto.

    Xxxxxxxxxxxxxxxxxx

    xxxxxxxxxx

    2

    2.1 Comp

    Xxxxxxxxxxxxxxxxxx

    xxxxxxxxxxxxxxxxxxx

    xxxxx

    2.2 Proto Analy..

    Xxxxxxxxxxxxxxxxxx

    xxxxxxxxxx

    3

    Top View

    Side View Front View

  • 8/3/2019 Documenting Robot Project Work

    6/7

    Format for Documentation of Robot Development Page 6

    This section presents details on the robot body design. Start with an introductory

    paragraph that describes the robot body in general. Use a multiview layout (pictures or

    drawings), as shown in Figure 4, to illustrate the robot shape and size. Use subheadings

    to describe the main features of the robot (for example, Gearing, Bumpers, RestraintDevice, (etc).

    3.0 Design Specification

    This section outlines the programs written for your robot. For example, the

    subheadings could be

    3.1 robotic arm or end effecter,3.2 Car and3.3 Supply Robot.

    Before each sample of the programming code, write several sentences explaining what

    the program does and the logic. These initial comments will help the reader more easily

    decipher the code. Then include a figure showing the program (include a print out of

    the code in the appendix). You may include arrows and text boxes to further explain the

    program. The code must be readable, so use multiple screenshots if necessary.

    4.0 Design Process

    Explain the process your team went through to come up with the final design. Most

    likely you built and programmed multiple robots before you found a working solution.

    Trace through the history of your design process by describing each robot you built,

    what was wrong with it, and how you fixed the problems (either construction or

    programming) with the redesign. Be careful to not repeat the same information in

    section 2.0.

    Performance Results and Discussion

    This section briefly presents the expectations of