11.3 The project report: Writing for the client, not for history Flashcards
What is the purpose of a final project report?
The purpose of a final project report is to communicate with the client in terms that ensure the client’s thoughtful acceptance of a team’s design choices.
What do the client’s interests demand regarding the design problem?
The client’s interests demand a clear presentation of the design problem, including:
- analyses of the needs to be met
- the alternatives considered
- the bases on which decisions were made
- the decisions that were taken made
How should the results of a project report be summarized?
The results of a project report should be summarized in clear, understandable language.
Where is highly detailed or technical materials typically located in a report? Why is it placed there?
Highly detailed or technical materials, as well as supporting materials, are often placed:
- in appendices at the end of the report
- in order to maintain clarity
- in separate volumes
- especially for large public works projects
When is clear, simple language and separation of technical and other materials in reports especially important?
Clear, simple language and separation of technical and other materials in reports especially important when the client and the principal stakeholders are not engineers or technical managers, but perhaps members of the general public.
Describe the sequence of a useful structured process that a design team might follow.
One structured process that a design team might follow would include the following steps:
- Determine the purpose and audience of the technical report
- Construct a rough outline of the overall structure of the report
- Review that outline within the team and with the team’s managers or, in case of an academic project, with the faculty advisor
- Construct a topic sentence outline (TSO)
- Review the TSO with the team
- Distribute individual writing assignments
- Assemble, write, and edit an initial draft
- Solicit reviews of the initial draft from managers and advisors
- Revise and rewrite the initial draft to respond to the reviews
- Prepare the final version of the report
- Present the final report to the client.
For which audience should the project report be written?
A project report often has several different audiences. The team, however, should write clearly and well for each audience, regardless of the organizational principle selected.
What are the major sections into which a report is typically divided?
Major sections into which the report is divided, which typically are:
- abstract
- executive summary
- introduction and overview
- problem statement and problem definition or framing
- including relevant prior work or research
- design alternatives considered
- evaluation of design alternatives and basis for design selection
- results of the alternatives analysis and design selection
- supporting materials
- often set out in appendices
- include:
- drawings and details
- fabrication specifications
- supporting calculations
- modeling results
- other materials that the client may require.
What does every entry in a topic sentence outline represent?
Every entry in a topic sentence outline represents a paragraph.
What is usually useful to create once the rough outline of a report has been established?
Once the rough outline of a report has been established, it is usually quite useful to build a corresponding, detailed topic sentence outline (TSO) that identifies the themes or topics that, collectively, make up the report.
What is an advantage of rough outlines and topic sentence outlines?
One advantage of a rough outline and a topic sentence outline is that their structures allows teams members to write in parallel or simultaneously.
What is a key role pertaining to the report?
One member of the team should enjoy the rights, privileges, and responsibilities pertaining to being the editor.
What is the role of the report editor?
The editor’s role is to ensure that report:
- flows continuously
- is consistent
- is accurate
- speaks in a single voice
What is meant by continuity?
Continuity means that topics and sections follow a logical sequence that reflects the structure of the ideas in the rough outline and the TSO.
What is meant by consistency?
Consistency means that the report uses common:
- terminology
- abbreviations
- acronyms
- notation
- units
- similar reasoning styles
and so on, throughout the report and all of its appendices