Asee peer logo

Documentation Of Automation Projects

Download Paper |


1997 Annual Conference


Milwaukee, Wisconsin

Publication Date

June 15, 1997

Start Date

June 15, 1997

End Date

June 18, 1997



Page Count


Page Numbers

2.157.1 - 2.157.10



Permanent URL

Download Count


Request a correction

Paper Authors

author page

Jose A. Macedo

Download Paper |

NOTE: The first page of text has been automatically extracted and included below in lieu of an abstract

Session 3157

Documentation of Automation Projects

Jose A. Macedo Texas Tech University

This paper describes a method to teach documentation skills as part of automation design projects. At the beginning of the semester, students are given a simple automated system and assigned the task of improving it in some sense. They are guided through the following steps: generate ideas for improving the existing system, prepare a proposal for approval by the instructor explaining the improvements, plan and execute the approved modifications, and prepare technical documentation. Students work in teams of three to four students. The projects are carried over from year to year. At the beginning of a semester, each team receives all the documentation generated the previous semester. The students understand that the documentation they generate will be useful for other students in the future, therefore they are motivated to produce clear and complete reports. Documents generated include: project proposal, project technical report, user manual to operate the project, poster board, and video tape of final presentation. Results from this laboratory are encouraging. The level of motivation in students is very high, and most of them complete the course with a very good understanding of concepts discussed in class.


Being able to document design projects and communicate results is an important skill for practicing engineers. There are reports in the literature 2, 3 that discuss methods to improve teaching these skills to undergraduate engineering students. Audeen Fentiman 2 indicates that students do not learn much by writing final reports poorly and receiving feedback in the form of instructor comments and a grade. Students can benefit the most by doing it properly. Therefore students should be given the opportunity to correct deficiencies, which requires instructors to plan report deadlines a week or two earlier than normal to allow enough time for grading by the instructor and make corrections by the students. The approach presented in this paper requires students to correct deficiencies in their documentation as shown in the Gantt charts in Figure 1 (activities 13, 14 and 15), and in Figure 2 (activities 13, 14, 15 and 16).

From experience in conducting courses with projects in which students are required to design and build something, students often prepare design documents after the project is built only to satisfy the instructor’s requirements. For example, I recall an instance in which an electrical engineering student avoided preparing a wiring diagram until the device was completely wired. There were several corrections done to the wiring during construction, and the student argument was that he wanted to avoid redoing the diagram after each change. That argument neglets the likely possibility that by using a wiring diagram as a planning and design tool, the corrections made to the wiring could have been avoided. Another example is

Macedo, J. A. (1997, June), Documentation Of Automation Projects Paper presented at 1997 Annual Conference, Milwaukee, Wisconsin. 10.18260/1-2--6522

ASEE holds the copyright on this document. It may be read by the public free of charge. Authors may archive their work on personal websites or in institutional repositories with the following citation: © 1997 American Society for Engineering Education. Other scholars may excerpt or quote from these materials with the same citation. When excerpting or quoting from Conference Proceedings, authors should, in addition to noting the ASEE copyright, list all the original authors and their institutions and name the host city of the conference. - Last updated April 1, 2015