Example Progress Report:
Debugging Techniques with Scheme
Annotations


Click on each of the links below to see the text referenced by the annotation. Scroll up and down in the document to see examples of the annotation. (In Netscape 2, you must reload and scroll to see the annotations in the right frame.) Use your browser's Back button to return to this page.



Overview. This progress report details the status of a student's work on debugging procedures in a computer programming language.

Memo format. If you've read about progress reports, you know that they can be formatted as business letters or memos or as separate reports with cover letters or memos. This one puts the report right inside a memo. Notice that this memo has all the standard elements�the to, from, subject, and date lines. Otherwise, standard headings, lists, and tables are used throughout the rest of the memo.

Introduction. In this introduction, the writer announces and the topic and purpose of the memo, provides an overview of what the rest of the memo contains, and gives a brief description of the project.

Project description. In this section, the writer provides an amplified description of the project�in particular, providing some discussion of the intended audience.

Project scope and topics. In this section, the writer reviews the topics that she intends to include in the document she is developing.

Work status. In these next three sections, the writer explains what she has completed, what he is currently working on, and what she is planning to do.

Conclusion�overall appraisal As typical with progress reports, this one ends with an overall appraisal of the project.

Outline. In any progress report, not only do you want to explain how the project is going, you also want to give readers a glimpse of the project in its current state. Since this project involves a written document, a good way to provide that glimpse is to present the outline. This gives the client a good opportunity to request changes if necessary. And, once the project is completed, if the client expresses dissatisfaction, the writer can point to this outline as some evidence of the client's acceptance of the work in its earlier stages.

That completes the comments for this example.


Interested in courses related to this page or a printed version? See the resources page. Return to the main menu of this online textbook for technical writing.

Information and programs provided by [email protected].