Structure

1 Introduction
2 Planning the Technical Report
  2.1 General overview of all required work steps and time planning
  2.2 Accepting and analyzing the task
  2.3 Checking or creating the title
  2.4 The structure as the “backbone” of the Technical Report
      2.4.1 General information about structure and table of contents
      2.4.2 Rules for the structure in ISO 2145
      2.4.3 Logic and formal design of document part headings
      2.4.4 Work steps to create a structure and example structures
      2.4.5 General structure patterns for Technical Reports
  2.5 Project notebook (jotter)
  2.6 The style guide advances consistency in wording and design
  2.7 References in chapter 2
3 Writing and Creating the Technical Report
  3.1 Parts of the Technical Report and their layout
      3.1.1 Front cover sheet and title leaf
      3.1.2 Structure with page numbers = Table of Contents (ToC)
      3.1.3 Text with figures, tables, and literature citations
      3.1.4 List of references
      3.1.5 Other required or useful parts
  3.2 Collecting and ordering the material
  3.3 Creating good tables
      3.3.1 Table numbering and table headings
      3.3.2 The morphological box – a special table
      3.3.3 Hints for evaluation tables
      3.3.4 Tabular re-arrangement of text
  3.4 Instructional figures
      3.4.1 Understandable design of instructional figures
      3.4.2 Figure numbering and figure subheadings
      3.4.3 Scheme and diagram (chart)
      3.4.4 The sketch as simplified technical drawing and illustration of computations
      3.4.5 Perspective drawing
      3.4.6 Technical drawing and bill of materials (parts list)
      3.4.7 Mind map
      3.4.8 Pictorial re-arrangement of text
      3.4.9 Creating paper images and graphics files and incorporating them into the Technical Report
  3.5 Literature citations
      3.5.1 Introductory remarks on literature citations
      3.5.2 Reasons for literature citations
      3.5.3 Bibliographical data according to ISO 690
      3.5.4 Citations in the text
      3.5.5 The list of references – contents and layout
  3.6 The text of the Technical Report
      3.6.1 Good writing style in general texts
      3.6.2 Good writing style in Technical Reports
      3.6.3 Formulas and computations
      3.6.4 Understandable Writing in Technical Reports
  3.7 Using word processing and desktop publishing (DTP) systems
  3.8 Completion of the Technical Report
      3.8.1 The report checklist assures quality and completeness
      3.8.2 Proof-reading and text correction according to ISO 5776
      3.8.3 Creating and printing the copy originals and end check
      3.8.4 Exporting the Technical Report to HTML or PDF for publication
      3.8.5 Copying, binding or stapling the Technical Report and distribution
  3.9 References in chapter 3
4 Useful behavior for working on your project and writing the Technical Report
  4.1 Working together with the supervisor or customer
  4.2 Working together in a team
  4.3 Advice for working in the library
  4.4 Organizing your paperwork
  4.5 Organizing your file structure and back-up copies
  4.6 Personal working methodology
  4.7 References in chapter 4
5 Presenting the Technical Report
  5.1 Introduction
      5.1.1 Target areas university and industrial practice
      5.1.2 What is it all about?
      5.1.3 What is my benefit?
      5.1.4 How do I proceed?
  5.2 Why presentations?
      5.2.1 Definitions
      5.2.2 Presentation types and presentation targets
      5.2.3 “Risks and side effects” of presentations and lectures
  5.3 Planning the presentation
      5.3.1 Required work steps and their time consumption
      5.3.2 Step 1: Defining the presentation framework and target
      5.3.3 Step 2: Material collection
      5.3.4 Step 3: The creative phase
  5.4 Creating the presentation
      5.4.1 General recommendations for designing presentation slides
      5.4.2 Step 4: Summarizing the text and working out the details
      5.4.3 Step 5: Visualization and manuscript
      5.4.4 Step 6: Trial presentation and changes
      5.4.5 Step 7: Updating the presentation and preparations in the room
      5.4.6 Step 8: Lecture, presentation
  5.5 Giving the presentation
      5.5.1 Contact preparations and contacting the audience
      5.5.2 Creating a relationship with the audience
      5.5.3 Appropriate pointing
      5.5.4 Dealing with intermediate questions
  5.6 Review and analysis of the presentation
  5.7 The short statement
      5.7.1 Trigger
      5.7.2 Requirements
      5.7.3 Example statement for a familiar audience
      5.7.4 Example statement for an unfamiliar audience
      5.7.5 Problems of short statements
      5.7.6 Tactical measures
  5.8 57 Rhetoric tips from A to Z
  5.9 References in chapter 5
6 Summary
7 References
A Appendix
  A.1 List of figures
  A.2 List of tables
B Glossary – terms of printing technology
C Index