tech report writing document

  • Accessibility
  • Staff search
  • External website
  • Schools & services
  • Sussex Direct
  • Professional services
  • Schools and services
  • Engineering and Informatics
  • Student handbook
  • Engineering and Design
  • Study guides

Guide to Technical Report Writing

  • Back to previous menu
  • Guide to Laboratory Writing

School of Engineering and Informatics (for staff and students)

tech report writing document

Table of contents

1 Introduction

2 structure, 3 presentation, 4 planning the report, 5 writing the first draft, 6 revising the first draft, 7 diagrams, graphs, tables and mathematics, 8 the report layout, 10 references to diagrams, graphs, tables and equations, 11 originality and plagiarism, 12 finalising the report and proofreading, 13 the summary, 14 proofreading, 15 word processing / desktop publishing, 16 recommended reading.

A technical report is a formal report designed to convey technical information in a clear and easily accessible format. It is divided into sections which allow different readers to access different levels of information. This guide explains the commonly accepted format for a technical report; explains the purposes of the individual sections; and gives hints on how to go about drafting and refining a report in order to produce an accurate, professional document.

A technical report should contain the following sections;

For technical reports required as part of an assessment, the following presentation guidelines are recommended;

There are some excellent textbooks contain advice about the writing process and how to begin (see Section 16 ). Here is a checklist of the main stages;

  • Collect your information. Sources include laboratory handouts and lecture notes, the University Library, the reference books and journals in the Department office. Keep an accurate record of all the published references which you intend to use in your report, by noting down the following information; Journal article: author(s) title of article name of journal (italic or underlined) year of publication volume number (bold) issue number, if provided (in brackets) page numbers Book: author(s) title of book (italic or underlined) edition, if appropriate publisher year of publication N.B. the listing of recommended textbooks in section 2 contains all this information in the correct format.
  • Creative phase of planning. Write down topics and ideas from your researched material in random order. Next arrange them into logical groups. Keep note of topics that do not fit into groups in case they come in useful later. Put the groups into a logical sequence which covers the topic of your report.
  • Structuring the report. Using your logical sequence of grouped ideas, write out a rough outline of the report with headings and subheadings.

N.B. the listing of recommended textbooks in Section 16 contains all this information in the correct format.

Who is going to read the report? For coursework assignments, the readers might be fellow students and/or faculty markers. In professional contexts, the readers might be managers, clients, project team members. The answer will affect the content and technical level, and is a major consideration in the level of detail required in the introduction.

Begin writing with the main text, not the introduction. Follow your outline in terms of headings and subheadings. Let the ideas flow; do not worry at this stage about style, spelling or word processing. If you get stuck, go back to your outline plan and make more detailed preparatory notes to get the writing flowing again.

Make rough sketches of diagrams or graphs. Keep a numbered list of references as they are included in your writing and put any quoted material inside quotation marks (see Section 11 ).

Write the Conclusion next, followed by the Introduction. Do not write the Summary at this stage.

This is the stage at which your report will start to take shape as a professional, technical document. In revising what you have drafted you must bear in mind the following, important principle;

  • the essence of a successful technical report lies in how accurately and concisely it conveys the intended information to the intended readership.

During year 1, term 1 you will be learning how to write formal English for technical communication. This includes examples of the most common pitfalls in the use of English and how to avoid them. Use what you learn and the recommended books to guide you. Most importantly, when you read through what you have written, you must ask yourself these questions;

  • Does that sentence/paragraph/section say what I want and mean it to say? If not, write it in a different way.
  • Are there any words/sentences/paragraphs which could be removed without affecting the information which I am trying to convey? If so, remove them.

It is often the case that technical information is most concisely and clearly conveyed by means other than words. Imagine how you would describe an electrical circuit layout using words rather than a circuit diagram. Here are some simple guidelines;

The appearance of a report is no less important than its content. An attractive, clearly organised report stands a better chance of being read. Use a standard, 12pt, font, such as Times New Roman, for the main text. Use different font sizes, bold, italic and underline where appropriate but not to excess. Too many changes of type style can look very fussy.

Use heading and sub-headings to break up the text and to guide the reader. They should be based on the logical sequence which you identified at the planning stage but with enough sub-headings to break up the material into manageable chunks. The use of numbering and type size and style can clarify the structure as follows;

  • In the main text you must always refer to any diagram, graph or table which you use.
  • Label diagrams and graphs as follows; Figure 1.2 Graph of energy output as a function of wave height. In this example, the second diagram in section 1 would be referred to by "...see figure 1.2..."
  • Label tables in a similar fashion; Table 3.1 Performance specifications of a range of commercially available GaAsFET devices In this example, the first table in section 3 might be referred to by "...with reference to the performance specifications provided in Table 3.1..."
  • Number equations as follows; F(dB) = 10*log 10 (F) (3.6) In this example, the sixth equation in section 3 might be referred to by "...noise figure in decibels as given by eqn (3.6)..."

Whenever you make use of other people's facts or ideas, you must indicate this in the text with a number which refers to an item in the list of references. Any phrases, sentences or paragraphs which are copied unaltered must be enclosed in quotation marks and referenced by a number. Material which is not reproduced unaltered should not be in quotation marks but must still be referenced. It is not sufficient to list the sources of information at the end of the report; you must indicate the sources of information individually within the report using the reference numbering system.

Information that is not referenced is assumed to be either common knowledge or your own work or ideas; if it is not, then it is assumed to be plagiarised i.e. you have knowingly copied someone else's words, facts or ideas without reference, passing them off as your own. This is a serious offence . If the person copied from is a fellow student, then this offence is known as collusion and is equally serious. Examination boards can, and do, impose penalties for these offences ranging from loss of marks to disqualification from the award of a degree

This warning applies equally to information obtained from the Internet. It is very easy for markers to identify words and images that have been copied directly from web sites. If you do this without acknowledging the source of your information and putting the words in quotation marks then your report will be sent to the Investigating Officer and you may be called before a disciplinary panel.

Your report should now be nearly complete with an introduction, main text in sections, conclusions, properly formatted references and bibliography and any appendices. Now you must add the page numbers, contents and title pages and write the summary.

The summary, with the title, should indicate the scope of the report and give the main results and conclusions. It must be intelligible without the rest of the report. Many people may read, and refer to, a report summary but only a few may read the full report, as often happens in a professional organisation.

  • Purpose - a short version of the report and a guide to the report.
  • Length - short, typically not more than 100-300 words
  • Content - provide information, not just a description of the report.

This refers to the checking of every aspect of a piece of written work from the content to the layout and is an absolutely necessary part of the writing process. You should acquire the habit of never sending or submitting any piece of written work, from email to course work, without at least one and preferably several processes of proofreading. In addition, it is not possible for you, as the author of a long piece of writing, to proofread accurately yourself; you are too familiar with what you have written and will not spot all the mistakes.

When you have finished your report, and before you staple it, you must check it very carefully yourself. You should then give it to someone else, e.g. one of your fellow students, to read carefully and check for any errors in content, style, structure and layout. You should record the name of this person in your acknowledgements.

Two useful tips;

  • Do not bother with style and formatting of a document until the penultimate or final draft.
  • Do not try to get graphics finalised until the text content is complete.
  • Davies J.W. Communication Skills - A Guide for Engineering and Applied Science Students (2nd ed., Prentice Hall, 2001)
  • van Emden J. Effective communication for Science and Technology (Palgrave 2001)
  • van Emden J. A Handbook of Writing for Engineers 2nd ed. (Macmillan 1998)
  • van Emden J. and Easteal J. Technical Writing and Speaking, an Introduction (McGraw-Hill 1996)
  • Pfeiffer W.S. Pocket Guide to Technical Writing (Prentice Hall 1998)
  • Eisenberg A. Effective Technical Communication (McGraw-Hill 1992)

Updated and revised by the Department of Engineering & Design, November 2022

School Office: School of Engineering and Informatics, University of Sussex, Chichester 1 Room 002, Falmer, Brighton, BN1 9QJ [email protected] T 01273 (67) 8195 School Office opening hours: School Office open Monday – Friday 09:00-15:00, phone lines open Monday-Friday 09:00-17:00 School Office location [PDF 1.74MB]

Copyright © 2024, University of Sussex

Bit Blog

Technical Report: What is it & How to Write it? (Steps & Structure Included)

' src=

A technical report can either act as a cherry on top of your project or can ruin the entire dough.

Everything depends on how you write and present it.

A technical report is a sole medium through which the audience and readers of your project can understand the entire process of your research or experimentation.

So, you basically have to write a report on how you managed to do that research, steps you followed, events that occurred, etc., taking the reader from the ideation of the process and then to the conclusion or findings.

Sounds exhausting, doesn’t it?

Well hopefully after reading this entire article, it won’t.

A girl writing a technical report

However, note that there is no specific standard determined to write a technical report. It depends on the type of project and the preference of your project supervisor.

With that in mind, let’s dig right in!

What is a Technical Report? (Definition)

A technical report is described as a written scientific document that conveys information about technical research in an objective and fact-based manner. This technical report consists of the three key features of a research i.e process, progress, and results associated with it.

Some common areas in which technical reports are used are agriculture, engineering, physical, and biomedical science. So, such complicated information must be conveyed by a report that is easily readable and efficient.

Now, how do we decide on the readability level?

The answer is simple – by knowing our target audience.

Bit.ai Home Page CTA

A technical report is considered as a product that comes with your research, like a guide for it.

You study the target audience of a product before creating it, right?

Similarly, before writing a technical report, you must keep in mind who your reader is going to be.

Whether it is professors, industry professionals, or even customers looking to buy your project – studying the target audience enables you to start structuring your report. It gives you an idea of the existing knowledge level of the reader and how much information you need to put in the report.

Many people tend to put in fewer efforts in the report than what they did in the actual research..which is only fair.

We mean, you’ve already worked so much, why should you go through the entire process again to create a report?

Well then, let’s move to the second section where we talk about why it is absolutely essential to write a technical report accompanying your project.

Read more:  What is a Progress Report and How to Write One?

Importance of Writing a Technical Report 

1. efficient communication.

Technical reports are used by industries to convey pertinent information to upper management. This information is then used to make crucial decisions that would impact the company in the future.

Technical team communicating with each other

Examples of such technical reports include proposals, regulations, manuals, procedures, requests, progress reports, emails, and memos.

2. Evidence for your work

Most of the technical work is backed by software.

However, graduation projects are not.

So, if you’re a student, your technical report acts as the sole evidence of your work. It shows the steps you took for the research and glorifies your efforts for a better evaluation.

3. Organizes the data 

A technical report is a concise, factual piece of information that is aligned and designed in a standard manner. It is the one place where all the data of a project is written in a compact manner that is easily understandable by a reader.

4. Tool for evaluation of your work 

Professors and supervisors mainly evaluate your research project based on the technical write-up for it. If your report is accurate, clear, and comprehensible, you will surely bag a good grade.

A technical report to research is like Robin to Batman.

Best results occur when both of them work together.

So, how can you write a technical report that leaves the readers in a ‘wow’ mode? Let’s find out!

How to Write a Technical Report? 

When writing a technical report, there are two approaches you can follow, depending on what suits you the best.

  • Top-down approach- In this, you structure the entire report from title to sub-sections and conclusion and then start putting in the matter in the respective chapters. This allows your thought process to have a defined flow and thus helps in time management as well.
  • Evolutionary delivery- This approach is suitable if you’re someone who believes in ‘go with the flow’. Here the author writes and decides as and when the work progresses. This gives you a broad thinking horizon. You can even add and edit certain parts when some new idea or inspiration strikes.

A technical report must have a defined structure that is easy to navigate and clearly portrays the objective of the report. Here is a list of pages, set in the order that you should include in your technical report.

Cover page- It is the face of your project. So, it must contain details like title, name of the author, name of the institution with its logo. It should be a simple yet eye-catching page.

Title page- In addition to all the information on the cover page, the title page also informs the reader about the status of the project. For instance, technical report part 1, final report, etc. The name of the mentor or supervisor is also mentioned on this page.

Abstract- Also referred to as the executive summary, this page gives a concise and clear overview of the project. It is written in such a manner that a person only reading the abstract can gain complete information on the project.

Preface – It is an announcement page wherein you specify that you have given due credits to all the sources and that no part of your research is plagiarised. The findings are of your own experimentation and research.

Dedication- This is an optional page when an author wants to dedicate their study to a loved one. It is a small sentence in the middle of a new page. It is mostly used in theses.

Acknowledgment- Here, you acknowledge the people parties, and institutions who helped you in the process or inspired you for the idea of it.

Table of contents – Each chapter and its subchapter is carefully divided into this section for easy navigation in the project. If you have included symbols, then a similar nomenclature page is also made. Similarly, if you’ve used a lot of graphs and tables, you need to create a separate content page for that. Each of these lists begins on a new page.

A lady creating table of contents in a technical report

Introduction- Finally comes the introduction, marking the beginning of your project. On this page, you must clearly specify the context of the report. It includes specifying the purpose, objectives of the project, the questions you have answered in your report, and sometimes an overview of the report is also provided. Note that your conclusion should answer the objective questions.

Central Chapter(s)- Each chapter should be clearly defined with sub and sub-sub sections if needed. Every section should serve a purpose. While writing the central chapter, keep in mind the following factors:

  • Clearly define the purpose of each chapter in its introduction.
  • Any assumptions you are taking for this study should be mentioned. For instance, if your report is targeting globally or a specific country. There can be many assumptions in a report. Your work can be disregarded if it is not mentioned every time you talk about the topic.
  • Results you portray must be verifiable and not based upon your opinion. (Big no to opinions!)
  • Each conclusion drawn must be connected to some central chapter.

Conclusion- The purpose of the conclusion is to basically conclude any and everything that you talked about in your project. Mention the findings of each chapter, objectives reached, and the extent to which the given objectives were reached. Discuss the implications of the findings and the significant contribution your research made.

Appendices- They are used for complete sets of data, long mathematical formulas, tables, and figures. Items in the appendices should be mentioned in the order they were used in the project.

References- This is a very crucial part of your report. It cites the sources from which the information has been taken from. This may be figures, statistics, graphs, or word-to-word sentences. The absence of this section can pose a legal threat for you. While writing references, give due credit to the sources and show your support to other people who have studied the same genres.

Bibliography- Many people tend to get confused between references and bibliography. Let us clear it out for you. References are the actual material you take into your research, previously published by someone else. Whereas a bibliography is an account of all the data you read, got inspired from, or gained knowledge from, which is not necessarily a direct part of your research.

Style ( Pointers to remember )

Let’s take a look at the writing style you should follow while writing a technical report:

  • Avoid using slang or informal words. For instance, use ‘cannot’ instead of can’t.
  • Use a third-person tone and avoid using words like I, Me.
  • Each sentence should be grammatically complete with an object and subject.
  • Two sentences should not be linked via a comma.
  • Avoid the use of passive voice.
  • Tenses should be carefully employed. Use present for something that is still viable and past for something no longer applicable.
  • Readers should be kept in mind while writing. Avoid giving them instructions. Your work is to make their work of evaluation easier.
  • Abbreviations should be avoided and if used, the full form should be mentioned.
  • Understand the difference between a numbered and bulleted list. Numbering is used when something is explained sequence-wise. Whereas bullets are used to just list out points in which sequence is not important.
  • All the preliminary pages (title, abstract, preface..) should be named in small roman numerals. ( i, ii, iv..)
  • All the other pages should be named in Arabic numerals (1,2,3..) thus, your report begins with 1 – on the introduction page.
  • Separate long texts into small paragraphs to keep the reader engaged. A paragraph should not be more than 10 lines.
  • Do not incorporate too many fonts. Use standard times new roman 12pt for the text. You can use bold for headlines.

Proofreading

If you think your work ends when the report ends, think again. Proofreading the report is a very important step. While proofreading you see your work from a reader’s point of view and you can correct any small mistakes you might have done while typing. Check everything from content to layout, and style of writing.

Presentation

Finally comes the presentation of the report in which you submit it to an evaluator.

  • It should be printed single-sided on an A4 size paper. double side printing looks chaotic and messy.
  • Margins should be equal throughout the report.

Employees analysing sales report

  • You can use single staples on the left side for binding or use binders if the report is long.

AND VOILA! You’re done.

…and don’t worry, if the above process seems like too much for you, Bit.ai is here to help.

Read more:  Technical Manual: What, Types & How to Create One? (Steps Included)

Bit.ai : The Ultimate Tool for Writing Technical Reports

Bit.ai: Tool to create technical reports

What if we tell you that the entire structure of a technical report explained in this article is already done and designed for you!

Yes, you read that right.

With Bit.ai’s 70+ templates , all you have to do is insert your text in a pre-formatted document that has been designed to appeal to the creative nerve of the reader.

Bit features infographic

You can even add collaborators who can proofread or edit your work in real-time. You can also highlight text, @mention collaborators, and make comments!

Wait, there’s more! When you send your document to the evaluators, you can even trace who read it, how much time they spent on it, and more.

Exciting, isn’t it?

Start making your fabulous technical report with Bit.ai today!

Few technical documents templates you might be interested in:

  • Status Report Template
  • API Documentation
  • Product Requirements Document Template
  • Software Design Document Template
  • Software Requirements Document Template
  • UX Research Template
  • Issue Tracker Template
  • Release Notes Template
  • Statement of Work
  • Scope of Work Template

Wrap up(Conclusion)

A well structured and designed report adds credibility to your research work. You can rely on bit.ai for that part.

However, the content is still yours so remember to make it worth it.

After finishing up your report, ask yourself:

Does the abstract summarize the objectives and methods employed in the paper?

Are the objective questions answered in your conclusion?

What are the implications of the findings and how is your work making a change in the way that particular topic is read and conceived?

If you find logical answers to these, then you have done a good job!

Remember, writing isn’t an overnight process. ideas won’t just arrive. Give yourself space and time for inspiration to strike and then write it down. Good writing has no shortcuts, it takes practice.

But at least now that you’ve bit.ai in the back of your pocket, you don’t have to worry about the design and formatting!

Have you written any technical reports before? If yes, what tools did you use? Do let us know by tweeting us @bit_docs.

Further reads:

How To Create An Effective Status Report?

7 Types of Reports Your Business Certainly Needs!

What is Project Status Report Documentation?

Scientific Paper: What is it & How to Write it? (Steps and Format)

  Business Report: What is it & How to Write it? (Steps & Format)

How to Write Project Reports that ‘Wow’ Your Clients? (Template Included)

Bit bottom banner

Business Report: What is it & How to Write it? (Steps & Format)

Internship Cover Letter: How to Write a Perfect one?

Related posts

Vpn: working, benefits, protocols & role in cyber security, marketing proposal: what is it & how to create an effective one, objectives and key results (okr): definition, importance & examples, how to embed smartsheet spreadsheets to your documents, standard operating procedures (sop): what, types and how to write, 12 efficient ways to manage teams this year.

tech report writing document

About Bit.ai

Bit.ai is the essential next-gen workplace and document collaboration platform. that helps teams share knowledge by connecting any type of digital content. With this intuitive, cloud-based solution, anyone can work visually and collaborate in real-time while creating internal notes, team projects, knowledge bases, client-facing content, and more.

The smartest online Google Docs and Word alternative, Bit.ai is used in over 100 countries by professionals everywhere, from IT teams creating internal documentation and knowledge bases, to sales and marketing teams sharing client materials and client portals.

👉👉Click Here to Check out Bit.ai.

Recent Posts

User guide: how to write an effective one (tips, examples & more), ai-powered writing tools & generators (free and paid), 10 chatgpt use cases in software development, how to lead distributed engineering teams: best practices, time management for developers & engineers: techniques & tips, 7 best ai tools for time management.

Logo for Milne Publishing

Want to create or adapt books like this? Learn more about how Pressbooks supports open publishing practices.

1 The Formal Technical Report

For technical reports, formal and informal, readers are generally most interested in process and results. Clear presentation of results is at least as important as the results themselves; therefore, writing a report is an exercise in effective communication of technical information. Results, such as numerical values, designed systems or graphs by themselves are not very useful. To be meaningful to others, results must be supported by a written explanation describing how results were obtained and what significance they hold, or how a designed system actually functions. Although the person reading the report may have a technical background, the author should assume unfamiliarity with related theory and procedures. The author must consider supplying details that may appear obvious or unnecessary. With practice, the technical report writer learns which details to include.

The formal technical report contains a complete, concise, and well-organized description of the work performed and the results obtained. Any given report may contain all of the sections described in these guidelines or a subset, depending upon the report requirements. These requirements are decided by the author and are based on the audience and expected use of the report. Audience and purpose are important considerations in deciding which sections to include and what content to provide. If the purpose is to chronicle work performed in lab, as is typical for an academic lab report, the audience is typically the professor who assigned the work and the contents usually include detailed lab procedure, clear presentation of results, and conclusions based on the evidence provided. For a technical report, the audience may be colleagues, customers, or decision makers. Knowing the audience and what they are expecting to get out of reading the report is of primary consideration when deciding on sections to include and their contents.

There are certain aspects to all reports that are common regardless of audience and expected usage. Rather than relegate these overarching report-writing considerations to a secondary position, these items are presented before detailing the typical organization and contents for technical reports.

Universal Report-Writing Considerations

The items listed in this section are often overlooked by those new to technical report writing. However, these items set the stage for how a technical report is received which can impact the author, positively or negatively. While in an academic setting, the author’s grade could be impacted.  While in a professional setting, it is the author’s career that could be affected. Effective communication can make the difference in career advancement, effective influence on enacting positive change, and propelling ideas from thought to action. The list that follows should become second nature to the technical report writer.

Details to consider that affect credibility:

  • Any information in the report that is directly derived or paraphrased from a source must be cited using the proper notation.
  • Any information in the report that is directly quoted or copied from a source must be cited using the proper notation.
  • Any reference material derived from the web or Internet must come from documentable and credible sources. To evaluate websites critically, begin by verifying the credibility of the author (e.g. – credentials, agency or professional affiliation). Note that peer reviewed materials are generally more dependable sources of information as compared to open source. Peer review involves a community of qualified experts from within a profession who validate the publication of the author. Open source information may be created by non-qualified individuals or agencies which is often not reviewed and/or validated by experts within the field or profession.
  • Wikipedia is NOT a credible reference because the information changes over time and authors are not necessarily people with verifiable expertise or credentials.
  • Provide an annotated bibliography of all references. Typically, annotations in technical reports indicate what the source was used for and establish the credibility of the source. This is particularly important for sources with credibility issues. However, an annotation can clarify why a source with questionable credibility was used.
  • With the increasing availability of Generative Artificial Intelligence (AI) such as provided by ChatGPT, where GPT stands for Generative Pre-trained Transformer, credibility will likely be challenged more frequently and will be more difficult to establish. Generative AI models may provide invalid responses and a knowledgeable reader will pick up on that quickly.
  • Make sure to know the consequences if you violate rules provided by your instructor in an academic setting or by your employer in a workplace setting for presenting work by another or by AI as if it were your own (without citation). Additionally, there may be rules on how much of your work can be AI-generated and what annotation you are required to provide when using generative AI. Know the rules and if you can’t find the rules, ASK.
  • See Appendix A for information about citing sources and AI-generated content.

Details to consider that affect the professional tone:

  • Passive voice: “The circuit resistance will be measured with a digital multimeter”.
  • Active voice: “Measure the circuit resistance with a digital multimeter”.
  • Avoid using personal pronouns such as “you”, “we”, “our”, “they”, “us” and “I”. Personal pronouns tend to personalize the technical information that is generally objective rather than subjective in nature. The exception is if the work as a whole is meant to instruct than to inform. For example, technical textbooks whose only purpose is to instruct employ personal pronouns.
  • Avoid using “it”. When “it” is used, the writing often leads to a lack of clarity for the reader as to what idea/concept “it” is referring to, thus negatively impacting overall clarity of the writing.
  • Use correct grammar, punctuation, and spelling. Pay attention to and address spell and grammar check cues from writing software such as Microsoft (MS) Word.  

Details to consider that affect the professional appearance:

  • All figures and tables must be neatly presented and should be computer generated. Use a computer software package, such as Paint, Multisim, AutoCAD, or SolidWorks, to draw figures. If inserting a full-page figure, insert it so can be read from the bottom or from the right side of the page . ALL figures and tables must fit within or very close to the page margins.
  • Generate ALL equations using an equation editor and provide each equation on its own line. Under normal circumstances, there is no reason to embed an equation within a paragraph.  Depending on presentation and how many equations are involved, number the equations for easy reference.
  • Refer to appendix B for information on how to automatically create a Table of Contents and properly number pages.
  • If the report includes an abstract, it should be on an unnumbered page after the title page and before the Table of Contents or it can be included on the title page.
  • For all hard copy reports, all pages of the report must be 8 ½“ X 11” in size. Any larger pages must be folded so as to fit these dimensions. HOWEVER, in this day and age, an electronic submission is most common. Keep in mind that with an electronic submission, it is easier to provide an appealing look with color since a color printer is not required.

Details to consider that affect readability:

  • Every section and sub-section of the report needs to start with an introductory paragraph that provides the context for the section or sub-section.
  • Every figure, graph, table, and equation needs to be introduced to the reader prior to being presented to the reader. This introduction provides the context.
  • ALWAYS NUMBER AND PROVIDE A TITLE FOR ALL FIGURES .
  • Make sure that the verb used can actually operate on the noun. For example, stating “the goal for this report is to observe …” implies that the report can observe when it is likely that the goal of the work reported on is to make certain observations.
  • Check for spelling and grammar errors which are often highlighted with cues by the text editing software. Follow capitalization, punctuation, and indentation norms. Remember to capitalize the names of proprietary items such as licensed software.
  • Define acronyms and abbreviations prior to using them.

Finally, always consider carefully the context of information provided. Know your audience. Thoughtfully consider if a statement is clearly supported by the information provided without leaving your reader confused. Remember that by the time you are writing a report, you should know the information inside and out, but your audience is reading your report to learn.

Standard Components of a Formal Technical Report

Technical reports should be organized into sections and are typically in the order described in this section. While this is the recommended order, certain reports may lend themselves to either reordering sections and/or excluding sections.

The format for this page may vary, however, the following information is always included: report title, who the report was prepared for, who the report was prepared by, and the date of submission. This is not a numbered page of the report.

An abstract is a concise description of the report including its purpose and most important results . An abstract should not be longer than half a page, single-spaced, and must not contain figures or make reference to them. Technical authors are generally so focused on results that they neglect to clearly state the purpose for the work. That purpose is derived from the objectives or goals, most commonly provided by the person who assigned the work. In stating the purpose, it is critical to include key words that would be used in a database search since searches of abstracts are commonly used by professionals to find information they need to do their jobs and make important decisions. Results are summarized in the abstract but how much quantitative information is provided varies with report audience and purpose. It is common to include maximum percent error found in the experimental results as compared to theory. Do not use any specific technical jargon, abbreviations, or acronyms. This is not a numbered page of the report.

Table of Contents

Include all the report sections and appendices. Typically, sub-sections are also listed. This is not a numbered page of the report.

The Table of Contents is easy to include if you properly use the power of the software used to generate the report. The Table of Contents can be automatically generated and updated if the author uses built in report headings provided in the styles menu. It is worth the time and effort to learn these tools since their application are ultimately time-savers for report writers. Directions are provided in Appendix B on creating a Table of Contents in MS Word using section headings.

Introduction

The length of the Introduction depends on the purpose but the author should strive for brevity, clarity, and interest. Provide the objective(s) of the work, a brief description of the problem, and how it is to be attacked. Provide the reader with an overview of why the work was performed, how the work was performed, and the most interesting results. This can usually be accomplished with ease if the work has clearly stated objectives.

Additionally, the introduction of a technical report concludes with a description of the sections that follow the Introduction. This is done to help the reader get some more detailed information about what might be found in each of the report sections included in the body of the report (this does not include appendices). This can feel awkward but providing that information is the accepted standard practice across industries.

Be careful not to use specific technical jargon or abbreviations such as using the term “oscope” instead of “oscilloscope”. Also, make sure to define any acronyms or abbreviations prior to using them. For example, in a surveying lab report a student might want to refer to the electronic distance measuring (EDM) device. The first time the device is referred to, spell out what the acronym stands for before using the acronym, as demonstrated in the previous sentence. Apply this practice throughout wherever an acronym or abbreviation is used but not yet defined within the report.

Background Theory

The purpose of this section is to include, if necessary, a discussion of relevant background theory. Include theory needed to understand subsequent sections that either the reading audience does not already comprehend or is tied to the purpose for the work and report. For example, a report on resistor-capacitor electric circuits that includes measurement of phase shift would likely include a theoretical description of phase shift. In deciding what should or should not be included as background theory, consider presenting any material specific to the work being reported on that you had to learn prior to performing the work including theoretical equations used to calculate theoretical values that are compared to measured values. This section may be divided into subsections if appropriate. Keep the discussion brief without compromising on content relevant to understanding and refer the reader to and cite outside sources of information where appropriate.

The purpose of this section is to provide detailed development of any design included in the report. Do not provide a design section if there is no design aspect to the work. Be sure to introduce and describe the design work within the context of the problem statement using sentences; a series of equations without description and context is insufficient. Use citations if you wish to refer the reader to reference material. Divide this section into subsections where appropriate. For example, a project may consist of designing several circuits that are subsequently interconnected; you may choose to treat each circuit design in its own subsection. The process followed to develop the design should be presented as generally as possible then applied using specific numbers for the work performed. Ultimately, the section must provide the actual design tested and include a clear presentation of how that design was developed.

Theoretical Analysis

Although a theoretical analysis might be part of a design, the author needs to decide if that analysis should be included as part of the design section or a separate section. Typically, any theoretical work performed to develop the design would be included in the design section but any theoretical analysis performed on the design would be included in a separate section. Do not provide a theoretical analysis section if the theoretical work is all described as part of background theory and design sections. However, in most cases, a theoretical analysis section is included to provide important details of all analyses performed. Be brief. It is not necessary to show every step; sentences can be used to describe the intermediate steps. Furthermore, if there are many steps, the reader should be directed to an appendix for complete details. Make sure to perform the analysis with the specific numbers for the work performed leading to the theoretical values reported on and compared to experimental values in the results section of the report. Worth repeating: perform the analyses resulting in the numbers that are included as the theoretical values in the results section of the report. Upon reading the results section, the reader should be familiar with the theoretical values presented there because the reader already saw them in this section.

This section varies depending on requirements of the one who assigned the work and the audience. At a minimum, the author discusses the procedure by describing the method used to test a theory, verify a design or conduct a process. Presentation of the procedure may vary significantly for different fields and different audiences, however, for all fields, the author should BE BRIEF and get to the point . Like with any written work, if it is unnecessarily wordy, the reader becomes bored and the author no longer has an audience. Also, the procedure section should never include specific measurements/results, discussion of results, or explanation of possible error sources. Make sure all diagrams provided are numbered, titled, and clearly labeled.

Depending on the situation, there are two likely types of procedure sections. In one case, a detailed procedure may have already been supplied or perhaps it is not desirable to provide a detailed description due to proprietary work. In another case, it might be the author’s job to develop and provide all the detail so work can be duplicated. The latter is more common in academic lab settings. Writing guidelines for these possible procedure sections are provided below.

Procedure Type 1

Use this procedure type if you have been supplied with a detailed procedure describing the steps required to complete the work or detailed procedure is not to be supplied to potential readers (procedure may be proprietary). Briefly describe the method employed to complete the work. This is meant to be a brief procedural description capturing the intention of the work, not the details. The reader may be referred to the appendix for detailed procedure steps. The following list provides considerations for this type of procedure section.

  • Example: For measurements made over a range of input settings, provide the actual range without including the details of the specific input settings or order data was taken (unless order affects results).
  • If required by the person who assigned the work, include the detailed procedure in the appendix.
  • MUST provide detailed diagram(s) of all applicable experimental set-ups (i.e. circuit diagram) that include specific information about the set-up, such as resistor values.
  • Provide diagrams and/or pictures that will further assist the reader in understanding the procedural description.
  • Provide a details of any work performed for which prescribed steps were not provided and that the author deems necessary for the reader’s comprehension.
  • To test the theory of superposition, the circuit shown in Figure 1 is employed. The circuit is constructed on the lab bench and using MultismTM, a circuit simulation software. In both settings, a multimeter is used to measure the output voltage, as shown in Figure 1, for the following three cases: (1) Source 1 on and Source 2 off, (2) Source 1 off and Source 2 on, and (3) both sources on. These measurements are compared to the output voltage derived using theory as described earlier. Refer to the appendix for further detail or procedure.
  • In order to test the theory of superposition, first each team member must calculate the output voltage for the circuit shown in Figure 1 for the following three cases: (1) Source 1 on and Source 2 off, (2) Source 1 off and Source 2 on, and (3) both sources on. Then one team member is assigned to build the circuit on the lab bench while the other team member constructs the circuit in Multisim. Once constructed, turn Source 1 on and Source 2 off then connect the positive lead of the meter to the positive end of the output voltage and the negative lead of the meter to the negative end of the output voltage. Record the meter reading. Next turn on Source 2 and turn off Source 1. Again, measure the output voltage using the meter ….

Procedure Type 2

Use this procedure type if you have not been supplied with a detailed description of the steps required to complete the work and/or you were required to develop and report procedure. The reader should be able to repeat the work based on the content supplied in this section.

  • Equipment use
  • Equipment maintenance
  • Define terms specific to the technology
  • Measurement techniques and/or calibration
  • The description should be sufficiently clear so that the reader could duplicate the work. Do not assume that the reader has prior knowledge or access to prior reports, textbooks, or handouts.
  • If part of the procedure was successfully described in a previous report, either repeat the procedure or include that report in the appendix and refer the reader to it.
  • Where appropriate, provide additional diagrams and/or pictures to assist the reader in understanding the procedure.

Results and Discussion

Present the results of the work performed, within the context of the problem statement, using neatly organized and completely labeled tables and/or graphs whenever possible. When comparative data is available, present the data in a way that facilitates the comparison. For example, if theoretical and experimental values are available, present the values alongside one another accompanied by percent error. If it would help the reader understand the results, include a few sample calculations but put lengthy calculations in an appendix.

ALWAYS accompany results with a meaningful discussion. The discussion explains what the results mean and points out trends. In some cases, the results speak mostly for themselves and the discussion may be brief, i.e., “Table 2 shows that the designed variable modulus counter works as expected” along with a sentence or two stating how a variable modulus counter works and referring to parts of the table that verify/justify the statement. In other cases, the meaning of the results may not be as clear requiring more detailed discussion. In most cases, the results include data from more than one source to be compared to establish validity. Meaningful discussion immediately follows presentation of results and include:

  • commenting on percent difference making sure it is clear to the reader which values are being compared and establishing comparative size of the difference in relation to expectations (negligible, small, large),
  • cause for the difference (error sources are discussed further in the next paragraph), and
  • how the results inform the reader as framed by the work’s objectives.

All three of the points are important to a meaningful discussion but the third one is most often overlooked. Discussion related to (3) may provide a statement about the theory used to predict the measured data. That statement often includes the theoretical assumptions made to predict the results and what the measured results indicate about the applicability of those theoretical assumptions to the experimental setting.

ALWAYS discuss the possible significant sources of error and how accurate the results need to be in order to be meaningful. Do not include a discussion of possible sources of error that would not add significantly to the observed error. What counts as significant depends on the situation. For example, if the components used have a tolerance of 5% and the accuracy of the equipment is within 0.5% of the measured value, then the equipment does not add significant error. However, if the components used have only a 1% tolerance then equipment with 0.5% accuracy is problematic. In general, it is impossible to obtain error-free results, therefore when there is 0% error there is still cause for discussion to comment on the situation that may result in error-free results or meaningful justification for expectation of error-free results. Expecting some error is not an excuse for lack of attention to detail when conducting procedures that minimize the error. Errors are different from mistakes. It is unacceptable to report mistakes. If a mistake was made, the work must be repeated until acceptable tolerances are achieved before submitting a report. Please find more on discussing percent error or percent difference in Appendix C.

When working in industry, it is imperative to know required level of accuracy for results. Your supervisor or client will expect results within specifications. If that means repetitive measurements to check for accuracy within tolerance, then do it. If it means performing a detailed analysis prior to making measurements, then do it. In an academic setting, the result of laziness or lack of effort may only be a bad grade. In a workplace, you may get fired!

Other information pertaining to writing Results and Discussion section can be found in Appendix C. This information includes

  • How to calculate percent difference/error.
  • Typical magnitudes of percent error for courses where circuits are constructed.
  • What to consider writing about based on questions posed by the person assigning you to write the report.
  • Guidelines for graphs provided in a report.

In this final section of the body of the report, the author should briefly bring everything together. It is similar to the abstract except that now specific results are concluded upon in a quantitative way. Therefore, the conclusion should be a concise description of the report including its purpose and most important results providing specific quantitative information. The conclusion should not contain figures or refer to them. As with the abstract, the reader should be able to read this section on its own which means that there should be no specific technical jargon, abbreviations, or acronyms used.

Anywhere within your writing that you have either copied or paraphrased another source, you must cite that source. This entails two steps. One is to provide a parenthetical citation at the location in the report where the material that is not your own resides and the other is to provide the complete bibliographic information in a References page following the Conclusion section of the report. If an annotated bibliography is required, include an annotation for ALL sources describing what the source was used for within the report and establishes the source’s credibility.

Using the APA style, the parenthetical citation at the location in the document where the copied or paraphrased material exists includes: author, publication date, and page number(s). For sources with no author, the name of the reference material is used. All this information is included within parentheses thus being referred to as a “parenthetical citation”.

The full bibliographic information for all reference material cited within your writing is collected on the References page. In technical papers, the referenced sources are usually listed in the order they are referred to in the body of the report and, in fact, many published engineering papers will simply number the references and then use that number in square brackets to replace the parenthetical citation within the body of the report. Those new to this form of technical writing, often ask about how and where to list references used but not explicitly cited in the body of the report. However, if the reference is important enough to list, that generally means that there is an appropriate place to cite it in the body of the report, perhaps in the introduction or background theory. In Appendix A you can find further information about creating citations using citation generators available on the internet that will create a properly formatted citation for you when provided with the relevant information. Although citation generators are readily available, the one I recommend is from Calvin College called KnightCite due to the minimum sponsored advertisements and can be found at http://www.calvin.edu/library/knightcite/ .

The References section begins on a new page; not on the same page with the conclusion. Refer to Appendix A for detailed information on preparing the References section. Also, there is a wealth of information about citation styles, including lengthy guides and short handouts, at https://sunydutchess.libguides.com/citations .

One final note on references and providing bibliographic information concerns use of sources that may appear to be questionable. There is no doubt that information from a wiki is questionable since, by definition, it can be changed by users including unqualified users. Although most wikis are reviewed and erroneous or misleading information corrected, at any given time there could be erroneous and misleading information. However, depending on report content, internet sources, including .com sites that have industry bias and .org sites that have policy bias, may have valuable information. Even .edu sites can be problematic if site is by an individual rather than an educational group within the institution since the former is likely not to have any editors and the latter is likely to be monitored and curated by the group. In order to establish credibility or usefulness of a source, especially a questionable one, provide an annotation to the bibliographic information that provides further information as to why the source was included and perspective on its application to the work reported. Information about annotated bibliographies is provided in Appendix A.

This section may not always be present. Materials included in an appendix may include lab sheets, parts list, diagrams, extensive calculations, error analyses, and lengthy computer programs.  Introduce numbered or lettered appendices rather than putting different items in one appendix.

Technical Report Writing Guidelines Copyright © by Leah M. Akins is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License , except where otherwise noted.

Share This Book

Logo for WI Technical Colleges Open Press

Want to create or adapt books like this? Learn more about how Pressbooks supports open publishing practices.

Chapter 1: Introduction to Technical and Report Writing

Bay College

Learning Objectives

What is Technical Writing? [1]

You’re probably wondering what this “technical writing thing” is. Someone may even have told you, “It’s this course where they make you write about rocket science and brain surgery.” Well, not really, as you will see in a moment. Actually, the field of technical communication is essential in a wide range of fields and occupations. It is a fully professional field with degree programs, certifications, and—yes!—even theory. It’s a good field with a lot of growth and income potential; and an introductory technical-writing course for which this book has been developed is a good way to start if you are interested in a career in this field .

Technical writing is an audience-centered means of communication that provides a reader with clear and easy access to information. In the business world, time equates to profit, and profit is the force behind all business interaction. The technical writer and reader have a vis-à-vis relationship. The writer recognizes, respects, and addresses the importance of time in effective and efficient communication by providing documents written in specific formats, using unambiguous language to send clearly accessible information. The reader in turn thoroughly understands the information in order to give a thoughtful response.

The Meaning of “Technical”

Technical communication—or technical writing, as the course is often called—is not writing about a specific technical topic such as computers, but about any technical topic. The term “technical” refers to knowledge that is not widespread, that is more the territory of experts and specialists. Whatever your major is, you are developing an expertise—you are becoming a specialist in a particular technical area. And whenever you try to write or say anything about your field, you are engaged in technical communication .

Academic Writing Versus Technical Writing    

The definite purpose, strict format and use of appropriate language in technical writing define the differences between technical writing and academic writing.  The academic writer’s purpose may be to write an assignment, a story, a letter, etc.. These works may or may not have a reader. However, technical writing always has a definite purpose and will always have a reader.  Regardless of the number of the intended readers of a document who may or may not read the document, the document will be read by the primary reader.

Workplace Writing

However, the focus for technical-writing courses is not necessarily a career as a technical writer but an introduction to the kinds of writing skills you need in practically any technically oriented professional job. No matter what sort of professional work you do, you’re likely to do lots of writing—and much of it technical in nature. The more you know about some basic technical-writing skills, which are covered in this guide and in technical-writing courses, the better job of writing you’re likely to do. And that will be good for the projects you work on, for the organizations you work in, and—most of all—good for you and your career .

Really Technical Writing

Keep relaxing, but you should know that professional technical writers do in fact write about very technical stuff—information that they cannot begin to master unless they go back for a Ph.D. But wait a minute! The technical documents have to ship with the product in less than nine months! How do they manage? Professional technical writers rely on these strategies to ensure the technical accuracy of their work:

  • Study of books, articles, reports, websites related to the product
  • Product specifications: what the product is supposed to do, how it is designed
  • Interviews with subject matter experts: the product specialists, developers, engineers
  • Product meetings during the development cycle
  • Live demonstrations of the product
  • Familiarization with similar, competing products
  • Experimenting with working models of the product
  • Most importantly, subject matter experts’ review of technical writers’ work for technical accuracy and completeness

Of course, experienced technical writers will tell you that product development moves so fast that specifications are not always possible and that working models of the product are rarely available. That’s why the subject matter experts’ review is often the most important.

Considerations of Technical Documents

There are key components of what makes a document strong. Therefore, writers keep these items in mind while constructing technical documents.

The Importance of Audience

Another key part of the definition of technical communication is the receiver of the information—the audience. Technical communication is the delivery of technical information to readers (or listeners or viewers) in a manner that is adapted to their needs, level of understanding, and background. In fact, this audience element is so important that it is one of the cornerstones of this course: you are challenged to write about highly technical subjects but in a way that a beginner—a nonspecialist—could understand. This ability to “translate” technical information to non-specialists is a key skill to any technical communicator. In a world of rapid technological development, people are constantly falling behind and becoming technological illiterates. Technology companies are constantly struggling to find effective ways to help customers or potential customers understand the advantages or the operation of their new products .

Not only is the the level at which you write important but so are the language choices you make as you do so. Please review the information on the following link for tips: Use Language that is Sensitive to Your Audience [2]

So relax! You don’t have to write about computers or rocket science—write about the area of technical specialization you know or are learning about. Also, plan to write about it in such a way that even Grandad can understand !

Formatting and Language

Formatting and appropriate language are the basic design elements of all technical documents.  A format that shows a hierarchical structure and a coordinate structure of information  le ads the reader thorough text.

Textbook image

Readers should be able to identify a writer’s organizational pattern very quickly when reading a technical document . This sometimes refers to a document being “reader friendly.”  In addition , using appropriate language is significant in providing the reader with a thorough understanding of the purpose of the document, how the document relates to the reader’s needs, and what action is expected of the reader. [3]

A document may also have one reader (the primary reader) or several readers (the secondary readers). A primary reader is the person who ordered the report to be written or the person for whom a report is intended. These readers will usually read the entire report. Secondary readers are those readers who will read only the sections of the report that relate to them, their jobs, their departments, responsibilities, etc. For example, if a report was sent that detailed funding for different departments, a piping superintendent may only want to read the section that relates to piping. This is where format, the use of headings, is significant in allowing the reader easy access to information. When the piping superintendent can scan through the document and clearly find the heading that identifies his department saves time.

Cultural Communication

Technical writers need to be aware of the differences between the behavior and the norms, beliefs and values of specific cultural. According to Edward T. Hall and Mildred Reed Hall, In Understanding Cultural Differences, each culture operates according to its own rules (1990, pp. 3-4).  Hall and Hall add that problems occur when members of one culture apply the rules to another culture (1990, pp. 3-4). To communicate effectively with other cultures, the technical writer needs to not only be aware of rules governing behaviors that can be observed but also of the not-so-obvious rules that govern the norms, beliefs, and values of the people of a culture. The invisible rules of a culture dramatically impact the acceptance of ideas, plans, and strategies.  The Cultural Iceberg illustrates patterns of world communication, showing indicators of Institutional Culture (the obvious behavior of a culture), which can be clearly seen as the tip of the iceberg, and People Culture (the norms, beliefs and values of a culture), which cannot be seen and which are the barriers to successful communication .

Figure 2 The Cultural Iceberg

The Cultural Iceberg. Awareness is the top part of the iceberg. It includes Institutional Culture/Behavior such as government, education, economy, language, and laws. The hidden part of the iceberg is Unawareness of people's culture/cultural norms, values, and beliefs. It includes the concepts of time, space, and humor; intelligence; status; competition/cooperation; and theory of past and future.

Technical writers have a responsibility to their readers and to their employers to follow ethics when writing reports. 

Law and Ethics Text with Watch

Technical writers must use words that demonstrate valid appeals to reason, avoiding emotional words and phrases that appea l to basic emotion instead of justifiable reasoning. In addition, technical writers must use valid references to support ideas and strategies, avoiding referencing non experts to sway readers’ support. Also, technical writers must use accurate numbers to report data, avoiding charts and tables that skew data. Using any type of fallacies in technical writing is unethical and could result in dire consequences.

Not only do technical writers have a responsibility to report accurate information, but they also have a responsibility to credit accurate sources of information. At no time is it acceptable to rearrange information in order to attempt to indicate that the writer is the source of someone else’s idea or to indicate that the writer read a report that included information he/she cited, when the primary source of the information was cited in another report.  All sources must be referenced accurately in the text and cited on a reference page.

Daniel G. Riordan (2005), in Technical Report Writing Today, cites Dombrowski to define three threads of ethics:

One major thread is that the communicator must be a good person who cares for the audience. Communicators must tell the truth as convincingly as possible, because truth will lead to the good of the audience. Another thread is that the communicator must do what is right, regardless of possible outcomes. A third thread is that communicators must act for the greatest good for the greatest number of people (p. 16) .

In addition, Riordan (2005) references the “code of ethics of the Society for Technical Writers, and cites five of the code’s tenants:

My commitment to professional excellence and ethical behaviors means that I will …

  • Use language and visuals with precision.
  • Prefer simple direct expression of ideas.
  • Satisfy the audience’s need for information, not my own need for self-expression.
  • Hold myself responsible for how well my audience understands my message.
  • Report the work of colleagues, knowing that a communication problem may have more than one solution (Riordan, 2005, pp. 15-16) .

Hall, E. T. & Hall, M. R. (1990). Understanding Cultural Differences. Yardmouth: Intercultural Press, Inc.

Riordan, D. G. (2005).  Technical Report Writing Today.  Boston: Houghton Mifflin Company.

Visuals & Readability

To make a document more reader friendly, many technical writers rely on visuals to achieve this goal. [5] For example , la bels, callouts and captions are identifying text for graphics . Labels and callouts identify specific elements or features on a graphic; whereas captions are short phrases or sentences that describe the graphic. Notes, or footnotes, explain, or give credit.

Labels and Callouts

To identify specific elements or features, labels and captions are placed directly on the graphic or near it. “Although the terms are used interchangeably, labels are text identifiers that are self-explanatory in an image, while callouts are labels that require further information outside the image to explain what they are identifying” (Gurak 304). They supplement the visual information. But use them selectively; use them only if readers need them (Rude 116).

The advantage of labels is that the reader gains a basic understanding of elements in the graphic without referring to supplementary explanations. But, too many labels obscure the image. In this case, callouts are the better option. Use numbers or letters to identify each element and the supplementary explanations.

Guidelines for Creating Labels and Callouts

  • Determine the number of items to identify in the image (Gurak 308).
  • Estimate how much explanation each item requires to determine if labels or callouts are more appropriate (Gurak 308).
  • create a consistent visual style (Gurak 308)
  • use the same terms on the label or callout as in the text (Rude 116)
  • in general, all parts mentioned in the text should have a label or callout, and all parts with a label or callout should be mentioned in the text. (Rude 116)
  • Use a standard font and size for readability (Rude 116)
  • Align the labels and callouts for a neater appearance (Rude 116)
  • If callouts are used, place the explanatory text in a key next to the graphic.

Labels can take different forms (Gurak 304 – 306):

  • They may be placed directly on the graphic (whereby they become part of the graphic).
  • They may be placed around the graphic and use lines to point to the relevant element in the graphic.
  • Online, labels can be links or hotspots whereby more information about the element is displayed on mouse rollover.

This is an example of l abels placed directly on the graphic.

Map of Central Park with labelled streets and park areas.

Figure 3 Map of the West Side Central Park, NYC between 102nd and 110th Streets.

Here, the labels are placed around the graphic.

Drawing of a flower with all parts labelled with lines to their placement on the drawing.

Figure 4 Parts of a flower.

In this sample, when the mouse is rolled over the ‘Firebox’ label, the text will read: “Literally a box containing the fire. It is surrounded by water on the top and all sides. The bottom is a grate with an ash pan below that.” Additional information is displayed .

Anatomy of a steam locomotive. Each part of the train is labelled with a line to the part.

Figure 5 Labels as hotspots.

Callouts are best used when many parts of the image need to be labeled and each part requires a longer explanation. In fact, the label sequence may be in alphabetical or numerical (as in Figure 6) order. Ensure that the explanation is near the graphic.

Sample Nutrition Facts label from Macaroni and Cheese. Call outs on the left side point to different parts of the label, such as Start Here, Check Calories, Limit these Nutrients, Get Enough of these Nutrients, Footnote, and the Serving Size.

Figure 6. How to understand and use the Nutrition Facts Label.

Coded callouts are in numerical sequence; the explanation for each number appears below the graphic. The example above shows part of the explanation of Number 1 explanation only.

Captions, table, and graphics titles must clearly identify information to the reader. Interpretive captions usually require one or more sentences. Captions should be informational, without becoming too lengthy. Captions that are merely a title for a graphic are not very helpful (Franklin 96).

Writing Style for Captions

  • Captions for graphics include the title and any explanatory material, immediately under the graphic.
  • Words such as Figure, Illustration, and Table should be in bold type.
  • The caption should be italicized.
  • Treat tables and figures the same.

Good captions are what guide readers not only to see, but also to understand. Captions label graphics with titles and explain to readers what they are seeing, and how to interpret the information captured in the visual. The Franklin Covey Style Guide for Business and Technical Communication provides an excellent source for writing captions (Franklin 39 – 41).

Five Specific Style Rules

  • Use interpretive captions whenever possible. I nterpretive captions provide both a title and explanatory information, usually expressed in a complete sentence, to help readers understand the central point(s) that the writer wants to convey. A graphic and its caption should be clear and understandable without requiring readers to search for clarifying information in the text:
  • Figure 4. Cabin-Temperature Control System. Constant cabin temperature control is maintained by the system’s modulated cabin sensor.
  • This interpretive caption gives the title and then tells the reader the principle message – that the check valve provides near-zero risk. And, it states how the check valve provides near-zero risk (Franklin 39).
  • Figure 23. Check Valve . The risk of bad air entering the changer is near zero because the check valve permits air flow in one direction only.
  • This interpretive caption gives the title of the figure and emphasizes that the cabin has a constant temperature – a benefit provided by the feature described in the figure. The caption states clearly what the writer wants the reader to learn from the drawing (Franklin 39).
  • Avoid using short, often ambiguous, titles to replace interpretive captions. In the past, styles for technical and scientific documents used only short, simple title captions for visuals. These were often superfluous, providing no real information other than the obvious to the reader, i.e. – A Horse. Titles that are so short and cryptic that they sound telegraphic are not useful. Such captions are only useful when the graphics are self-explanatory, and require no interpretation (Franklin 40).
  • Number figures and tables sequentially throughout the document, and place the number before the caption. If an important figure or table is presented twice, treat it as two separate visuals and number each. Figure and table numbers should be whole numbers (Franklin 40).
  • Captions may appear below or above a visual, but consistency throughout a document is critical. Arguments support both options; choose one, warrant your choice, and be consistent.
  • Put the caption above the visual for better visibility when captions are used with slides and other project visual aids. Captions placed at the bottom may be blocked by the heads of those seated in front (Franklin 99).

Notes or footnotes are categorized as either explanatory or source notes. Explanatory footnotes are identified by a superscript number or letter. The order in which notes appear is important; explanatory footnotes are placed above source notes. And both are placed above the caption, if the caption is placed at the bottom of the illustration.

A pie chart about Toxic Chemical Releases. Below the chart, a footnote is listed with a source note and caption.

Figure 7. Placement of footnote, source note and caption.

Source: Rude, p. 115, modified.

The Writing Process [6]

Writing, especially when compiling a larger document,  is not something you sit down, complete in one session, and quickly submit. This is especially true when writing for the workplace where accuracy and clarity are necessary. In fact, writing should be seen as a process that is recursive where the writer moves in and out of various stages of writing and often times revisits some of the stages. The writing process might consist of the following:

This is the planning done before writing a document. It may be defining the purpose of the task, analyzing the primary and secondary readers, sketching the document and what will go in each section, or gathering research.

This is writing and compiling a first draft of the document. Sometimes, the writer worries more about getting ideas down more than guaranteeing every punctuation or grammar choice is correct.

When a writer revises, a writer revisits the draft and makes substantial changes to it. This is more than editing. It is adding, deleting, and moving entire sections of the document around to prepare it as a final, comprehensive document. In fact, it is here that many writers ask others for feedback before revising to ensure that another, unbiased set of eyes have looked over the document and easily understand it.

This is the final part of the process. It is reading through the document several times while looking for clarity, consistency, and accuracy. In fact, consider reading your document aloud and listening to it as you do so instead of reading and “seeing” it. Most individuals communicate mostly through talking and listening. Therefore, when you read aloud, you can hear if something in your document doesn’t sound right and then correct it. You should be able to read it in a way that it is understandable and sounds conversational.

For additional information on the writing process, visit The Writing Center website for the University of Texas: University of Texas Writing Center & The Writing Process .

Using a process in the workplace and in our class will strengthen your documents significantly. In fact, remember that your documents reflect on who you are as student, technical writer, employee, and even researcher.

[1] Technical Writing. Authored by : Dr. Elizabeth Lohman. Provided by : Tidewater Community College. Located at : http://www.tcc.edu/ . Project : Z Degree Program. License : CC BY: Attribution , edited by Amber Kinonen , edits included in italics

[2] Use Language that is Sensitive to Your Audience. Provided by : Writing Commons. Located at : http://writingcommons.org/open-text/collaboration/143-common-comments/word-choice-/575-use-language-that-is-sensitive-to-your-audience . License : CC BY-NC-ND: Attribution-NonCommercial-NoDerivatives edited by Amber Kinonen , edits included in italics

[3] Image of Textbook. Authored by : Dominik Wagner. Located at : https://flic.kr/p/eoAvCb . License : CC BY: Attribution

[4] Image of Text with Watch. Authored by : Stephen Wu. Located at : https://flic.kr/p/tZ1LP . License : CC BY-NC-ND: Attribution-NonCommercial-NoDerivatives

[5] Norbert Elliot’s “Labels, Callouts, Captions and Notes” CC-BY Saylor, edited by Amber Kinonen , edits included in italics

[6] The Writing Process CC-BY Amber Kinonen

Chapter 1: Introduction to Technical and Report Writing Copyright © by Bay College is licensed under a Creative Commons Attribution 4.0 International License , except where otherwise noted.

Share This Book

Author(s): Leah M. Akins, Ph.D.


Creative Commons

Publication Date: July 18, 2023

Affiliation: Dutchess Community College

About the book

tech report writing document

This document specifies the recommended format to be used when submitting a formal technical report in a variety of disciplines and purposes. Also, this manual can be used as a guide to compose less formal reports, such as lab reports, that may consist of a subset of the items presented here. It is a useful general guide from which faculty can specify the particular requirements for reports in their courses.

Now in its eleventh iteration, the text was updated in July 2023 to include guidance on the use of AI in technical writing.

  • Introduction
  • 1. The Formal Technical Report
  • 2. How a Reader in Industry Peruses a Technical Report
  • 3. Questions to Ask Yourself Prior to Submitting Any Report
  • 4. Conclusion
  • APPENDIX A: “How To” Guide on References and Citations
  • APPENDIX B: Page Numbering and Table of Contents using MS Word
  • APPENDIX C: Writing Tips for Discussing Results

About the Author(s)

Leah m. akins, ph.d.
, using this text fill out this short questionnaire to let us know about you and how you are using this text, available now , english and communication , general studies , technology | subjects/keywords: technical writing.

Henry Harvin Blog

Home > Learn More About Technical Writing > Technical Report Writing: A Comprehensive Guide

Technical Report Writing: A Comprehensive Guide

tech report writing document

Free Counselling :

Table of Contents

tech report writing document

Technical report writing is a way of communicating information about a technical or scientific topic in a clear and concise manner. The goal is to convey complex ideas and data to a specific audience, often other professionals or decision-makers, in a format that is easy to understand.

Technical Writing

Technical report writing is key for jobs, study, and education. Explaining complicated technological concepts is essential, regardless of skill level. This tutorial analyzes technical report writing and offers helpful advice to help you improve.

7 Cs of Technical Writing Report

The 7Cs of communication are often connected with good written communication, rather than technical writing in particular. These concepts, however, can be used in technical writing to improve clarity and comprehension.

7 C's of Technical Writing

  • Clarity : Use clear, straightforward language. Avoid jargon and technical terms that might confuse the reader and organize your content logically.
  • Conciseness : Be brief and to the point. Avoid unnecessary words or information and Use bullet points and lists for easier readability.
  • Concreteness : Use particular facts and numbers. Give specific instances to support your arguments. Avoid using confusing or unclear wording.
  • Correctness : Make sure that your text is grammatically correct. Check for spelling and punctuation mistakes and Ensure the technical information is accurate.
  • Coherence : Check to ensure the information flows easily. Make use of transitions between paragraphs and sections and arrange your content logically.
  • Completeness : Provide all the information, respond to inquiries, and ensure no details are left out.
  • Courtesy : Be polite and respectful in your tone, Use a positive and professional tone, and Consider your audience and their level of understanding.

It is vital in technical writing to keep consistent (use the same style and words) and to provide proper context for understanding the technical stuff.

Understanding the Purpose of Technical Reports

Before delving into how to write a technical report, it’s critical to grasp its goal. Technical reports provide data, insights, and conclusions to a certain group. Whether you’re writing about research, a project, or a technical problem, stating your goals will guide your writing.

Knowing your audience is crucial. It helps you use the right language and provide the right amount of information for clear communication.

Structure and Organization

The structure of a technical report plays a pivotal role in conveying information logically and coherently. A well-organized report enhances readability and comprehension. The typical structure includes:

Technical Writing Course with Gold Membership

45-min online masterclass with skill certification on completion

Kounal Gupta (CEO, Henry Harvin)

Access Expires in 24Hrs

Register Now for Free

Images

Find our Upcoming Batches of Technical Writing Course :-

structure and organization of Technical writing

  • Title Page: Indicate the title, author, and any relevant institutional information.
  • Abstract: Summarize the key points of the report, providing a snapshot of the content.
  • Table of Contents: Outlining the structure and organization of the report.
  • Introduction: Setting the stage by introducing the problem or topic and stating the purpose of the report.
  • Literature Review: Providing context by reviewing relevant literature and previous work in the field.
  • Methodology: Detailing the procedures and methods used in gathering and analyzing data.
  • Results: Presenting the findings of your research or project.
  • Discussion: Interpreting the results, addressing limitations, and discussing implications.
  • Conclusion : A summary of the important ideas with an emphasis on significant takeaways.
  • Recommendations: Offering suggestions for future research or actions.
  • References: Citing sources used in the report.

Clarity and Conciseness

Technical reports should convey information clearly and concisely. Avoid unnecessary jargon and complex language that may confuse the reader. Use diagrams, charts, and tables strategically to illustrate key points. Additionally, be mindful of the tone, maintaining a formal and objective style throughout the report.

Data Presentation and Analysis

In a technical report, the main focus is on showing and studying data. Explain your method clearly, make sure the data is accurate and important, and present it in an easy-to-understand way. Use pictures to help explain, giving a full view of the information .

Citation and Referencing

Proper citation and referencing are crucial in technical report writing. Follow a recognized citation style (e.g., APA, MLA, IEEE) consistently throughout your report. Accurately citing sources not only gives credit to the original authors but also adds credibility to your work.

Revision and Proofreading

Give your technical report enough time for a full edit and proofread before submitting it. Check for grammatical problems and inconsistencies, and make sure the report follows the criteria. A polished report exhibits professionalism and accuracy.

Points to Remember while formatting Technical Report

Post graduate program in technical writing.

Strengthen your Writing prowess as you master the art of simplifying Complex Technical details into clear and well-structured documents

tech report writing document

It is important to pay attention to the format of a technical report when writing it for effective communication. Here are some important things to remember while formatting a technical report.

Points to Remember while Technical writing

  • A strategic title is the initial impression, conveying the essence of the report. It should be brief and indicative of the content to guide readers properly.
  • Break your report into parts like Introduction, Body, Conclusion, and Recommendations. Make sure headings and subheadings look the same to help people understand and find things easily. This keeps your information organized and easy to follow.
  • Use visuals like graphs to help people understand better. Make sure each visual is labelled and referred to in the text so everything makes sense.
  • Use clear and short words. Explain technical terms so everyone can understand. Make everything look the same with fonts, spacing, and indentation to look professional.
  • Make sure to cite accurately using a style like APA or MLA. List all your sources at the end. In the conclusion, briefly go over the main points, remind yourself why you wrote the report, and highlight the important insights.
  • Check and fix mistakes in your writing carefully. Ask friends or co-workers for their opinions to make your report better.
  • Insert page numbers and headers for easy reading. Keep a professional tone in your writing to make it trustworthy. Add extra stuff in the back (appendices) and mention it in the main text when needed.
  • To enhance readability, opt for a font size and line spacing that facilitate comprehension. Break down content into manageable paragraphs, making the report more digestible for readers.

Follow these formatting tips to make your report look good and share information well with your audience.

Henry Harvin Techinal Writing

Henry Harvin ‘s henryharvin.com Technical Writing Course

The goal of Henry Harvin’s Technical Writing Course henryharvin.com/technical-writing-course is to give students the abilities they need to communicate effectively in technical fields. This course focuses on practical learning and covers a variety of crucial topics. For course details, visit their official site or contact them directly.

Key Features

  • Comprehensive Module: The course covers several key subjects, such as document organization, data presentation, and the use of visuals. This ensures that participants get a complete understanding of technical writing.
  • Expert Instructors: Taught by experienced professionals.
  • Flexible Learning: Provides both online and classroom options for convenience.
  • Training : 36 hours of live, interactive, two-way online classroom instruction.
  • Practical Learning: Emphasizes hands-on experience and real-world projects.
  • Lifetime Access: Access to course materials and updates even after completion.
  • Placement Assistance, Internship opportunities, Interactive sessions, and Resume building are part of these courses.
  • Certification: Offers a recognized SEO certification upon course completion.
  • master classes, hackathons, and gold membership are all included in the program.
  • To know more about technical writing and blogs. henryharvin.com/blog/?s=technical+writing

In summary, learning how to write technical reports is a valuable skill that can greatly affect your success in school and work. To do it well, understand why you’re writing, organize your report carefully, keep it clear and concise, present data thoughtfully, and follow proper citation and revision rules. Practice a lot and get feedback to improve this skill over time.

A technical report is a detailed document that explains complex information on a specific topic clearly and organized. It’s like a guide that helps others understand technical or scientific subjects

A technical report usually starts with an introduction, introducing the topic and outlining what the report will cover. This sets the tone and gives readers a roadmap for what to expect in the report.

Visuals, like charts and diagrams, are used in technical reports to make information more visual and easily comprehended. They provide a quick way for readers to understand complex data, making the report more accessible.

Simple language ensures everyone, regardless of expertise, can easily understand the information presented in the report.

Recommended Programs

Content Writing Course with Gold Membership

*Learn from South Asia's Oldest Content Writing Course | Recognized by American Association of EFL, Content Writing Association of India, UK Cert, UKAF & MSME | Guaranteed Live Projects & Internship Opportunity.

*A cutting-edge Technical Writing Course which teaches you the fine art of transforming data and information accumulated through a process or experimental work into technical documentations and guides.

Creative Writing Courses with Gold Membership

Henry Harvin® Creative Writing Course Ranks#1 in India by The Statesman! Creative Master the creative writing skills to compose engaging Fiction, Creative Nonfiction, Drama, and Poetry that will snap a reader’s curiosity from the advent to end of your write-up.

Medical Writing Training Course and Certificate

A one-of-a-kind Medical Writing course which helps you get a thorough understanding of pharmaceutical regulatory writing as well as medico-marketing writing. Strengthen your writing prowess as you boost your skills as a medical and scientific writer. The Certified Medical Writer(CMW) certification is your key to success.

Recommended videos for you

Best Content Writing Tutorial for Beginners

Free Content Writing Tutorial for Beginners

Best Technical Writing Course

Technical Writing For Beginners

Creative Writing Course Tutorial

Understanding Creative Writing

Medical Writing Tutorials for Beginners

Vidya Rajesh

Myself Vidya Rajesh,  a budding content writer eager to explore the realm of creative expression. with BSc Computer Science and Content Digital Writer Certificate. I am excited to embark on a journey of continuous learning and growth in the dynamic field of content writing.

tech report writing document

What is COUNT in Excel, and how do I use the COUNTIF function in Excel?

tech report writing document

What are the Best Actionable SEO Techniques for 2024? [Updated]

Related posts.

tech report writing document

Best Technical Writing Course in Noida: 2024 [Updated]

tech report writing document

Top 14 Technical Writing Courses in Bangalore: 2024 [Updated]

tech report writing document

Top 10 Important Technical Writing Skills to Know (2024)

tech report writing document

What is Technical Writing: A Complete Guide 2024 Edition

tech report writing document

15 Ways to Improve Your Technical Writing in 2024 [Updated]

tech report writing document

Best Technical Writing Course in Guwahati: 2024 [Updated]

Join the discussion cancel reply.

Save my name, email, and website in this browser for the next time I comment.

tech report writing document

Our Career Advisor will give you a call shortly

tech report writing document

Just purchased a course

Type above and press Enter to search. Press Esc to cancel.

Engineering Technical Reports

Technical reports include various types of "technical" information. For example, if you need to report why a design or piece of equipment failed, you'd write a forensic report. Or, you might have to write about a design you created. Then, you'd produce a design report or, you may need to combine these two. Many report types are classified as technical reports. You should always determine what information you need to convey and who your audience is before you start writing.

Technical reports present facts and conclusions about your designs and other projects. Typically, a technical report includes research about technical concepts as well as graphical depictions of designs and data. A technical report also follows a strict organization. This way, when other engineers read what you write, they can quickly locate the information that interests them the most.

As a student, you might assume that your technical report's audience is your instructor, however, this may not always be the case. Your instructor may ask you to produce a report for your peers or for other engineers. However, you shouldn't always assume that your audience has a strong engineering background or is familiar with the engineering terminology you use. Always check with your instructor to know who your audience is.

As an engineer in the field, the most likely audience for the technical reports you produce is other engineers with a background similar to yours. This audience is more likely to understand the terminology you use. However, you should always evaluate who your readers will be before assuming they will understand your jargon. Consider how your readers will use your report. For instance, you might submit a technical report to a publication or your technical report may present a specific design. The audiences in each situation have different needs. Audiences may read the publication for information and insight while audiences reading about your specific design may critique your design or make decisions based on its content.

General Format

Technical Reports have an organized format because a majority of your audience may not read the entire report in one reading. This specific format allows readers to quickly locate the information they need.

Most technical reports include the parts listed below. However, you may be required to include or exclude specific sections. Be sure to check with your instructor before using the format outlined here.

Transmittal Letter

Transmittal letters often accompany reports and inform readers of a report's context. Typically, the letter includes information not found in the report. For example, the letter contains information about the particular project and/or due dates. A Transmittal Letter is a business letter and should be formatted accordingly; that is, you should include the recipient's address, your address, a salutation and closing. Depending on the project, you may also need to include contact information. Always check with your instructor to determine whether or not you should attach a transmittal letter to your report.

A technical report should always include a title clearly identifying the report. A title should be descriptive and accurate, but not wordy, verbose or too terse.

The Abstract is extremely important because it helps readers decide what to read and what to pass over. The idea of the Abstract is to give readers an honest evaluation of the report's content, so they can quickly judge whether they should spend their valuable time reading the entire report. This section should give a true, brief description of the report's content. The most important purpose of the Abstract is to allow somebody to get a quick picture of the report's content and make a judgment.

Since an Abstract is a brief summary of your report, its length corresponds with the report's length. So, for example, if your report is eight pages long, you shouldn't use more than 150 words in the Abstract. Generally, Abstracts define the report's purpose and content.

Executive Summary

Typically, Executive Summaries are written for readers who do not have time to read the entire technical report. An executive summary is usually no longer than 10% of the report. It can be anywhere from 1-10 pages long, depending on the report's length. In the executive summary, you should summarize the key points and conclusions from your report. You might include anexecutive summary with your report, or the summary can be a separate document.

Some reports only include an abstract while others include an executive summary. Always check with your instructor to determine which to include or if you should include both.

Table of Contents

A Table of Contents includes all the headings and subheadings in your report and the page numbers where each of these begins. When you create a Table of Contents, one of the most important decisions you have to make involves design. A good Table of Contents distinguishes headings from subheadings and aligns these with the appropriate page numbers. This also means you should pay attention to capitalization, spacing, and indentation.

List of Figures & List of Tables

These two separate lists assist readers in locating your photos, drawings, tables, graphs and charts. Like the Table of Contents, you need to present both of these in an organized, appealing format. Typically, you can shorten a figure or table's title when you create these lists.

Report Body

In a technical report, the body typically presents an Introduction, various other sections, depending on your topic, and a Conclusion. Throughout the body, you should include text (both your own and research from other sources), graphics, and lists. Whenever you cite information or use graphics from another source, you must credit these sources within your text. Check with your instructor to know which reference style to use.

Whenever you cite information (this includes graphics) from another source, you must credit the source in your References. Always check with your instructor to determine which reference style to use.

Appendices include information that is too large to fit within your report, yet information necessary to your report. For example, large graphics, computer print-outs, maps, or sample codes are best placed in Appendices. When making decisions about what to place in an Appendix, consider whether or not the material interrupts the reading flow. For instance, six pages of calculations would obviously cause readers to loose their train of thought. Appendices always appear at the end of a report.

Example Technical Report

As you read the example, keep in mind that this technical report was a requirement for CE208 at Colorado State University. The course instructor, Dr. Tom Siller, commented on this document. Other instructors or job situations may have different opinions or require a different format.

December 12, 1996

Dr. Tom Siller Colorado State University Fort Collins, CO 80524

Dear Mr. Siller:

We are submitting to you the report, due December 13, 1996, that you requested. The report is entitled CSU Performing Arts Center. The purpose of the report is to inform you of our design decisions for the center. The content of this report concentrates on the structural and acoustical aspects of the CSU Performing Arts Center. This report also discusses cable-stayed technology. If you should have any questions concerning our project and paper please feel free to contact Mike Bridge at 491-5048.

Sincerely, Mike Bridge Lead Engineer

Instructor Comments

This is not a very good business letter. In a business letter, you typically present your own address in addition to the receiver's address. Also, my address is incomplete. They need to include "Department of Civil Engineering." And what about a logo? Letterhead? Typically, businesses have letterhead.

Another problem is that the contact phone number is buried in the text. This makes it easy to miss. A good idea is to list the contact phone number under your title at the bottom. This letter should also provide a context for the project, "This final project was completed for CE 208…" In other words, this project represents your last say; no more is coming.

Project Engineers: Mike Bridge

Alice Lake Simon Civil Karen Nuclear

The title page here is missing key information. There should be date and client name (That'd be me!). A client in this environment is the class. For instance, you might say, "submitted for" or "to," something of that nature.

The format looks good. I like the use of bold in spots. It highlights the text.

It's also good that they identified themselves with the group.

MASK Engineering has designed a performing arts center for the CSU campus in order to provide a complex that will better serve the campus and the community. This facility will not only improve the performing arts programs on campus, but will encourage students and community members to attend more cultural events in Fort Collins. The capacity of the new facility will exceed that of existing structures on campus, and the quality of sound and aesthetics will be improved. Some of the features included are a large performing hall, a coffee shop, a banquet hall, and a recording studio. The total area of the complex is 56,500 square feet split into three levels.

This abstract summarizes the accomplishments of the project and what it will do. It also summarizes some of the actual design and indicates that it's going to include a performing hall, coffee shop, banquet hall, and recording studio.

The writing, however, could be a little tighter in my opinion. The first sentence looks like it's around 20 words long. First of all, that whole expression "will better service the Campus and the Community" doesn't mean anything. What does "better serve" mean? And so, I look at something like that and say, "Mask Engineering has designed a new Performing Arts Center that will meet the needs of the theater community," or something more specific.

And then the second sentence is typical. It gives the particular vehicle for doing the programs. It implies the facility improves programs, and I'm not sure that's quite the right subject in a sentence like that. There's no point in a "but" here. It will do this and this; it's not a contrast. They're not contrasting anything. And so, there are some grammatical problems here. I think these kinds of grammatical problems come up because students don't read carefully. They write it. To avoid this construction, read it sentence by sentence and say, "What does this sentence accomplish for me?" And you can see that this sentence structure doesn't accomplish; it implies there's a contrast, well, there is no contrast.

Then the abstract gets stronger. "The capacity of the new facility will exceed that," so they get very specific. "The quality, sound and ascetics will be improved. Some of the features included are this." They're very good at being descriptive and saying this, this and this. The struggle I think engineering students have is the motivational lead-in to their material. They're more comfortable at the descriptive aspect of their material.

Acknowledgments

MASK Engineering would like to thank Dr. Michael Schaff of the CSU Music Department and Ms. Annie Cleveland from the CSU Theater Department for their expertise and input for the CSU Performing Arts Center. We would also like to thank Dr. Tom Siller for his aid in our research and use of his research materials.

Excecutive Summary

Introduction

Our main goal was to design a Performing Arts Center for the CSU campus that would blend well with the rest of the campus. To achieve this goal, our group split into two smaller groups; Alice in one and Simon, Mike, and Karen in the other. Alice concentrated on acoustical aspects of the complex. Simon, Mike, and Karen concentrated on the structural plans.

In this section, we specify the exact location of the structure and why we believe it is a prime location.

Cable-stayed Technology

Here, we present our rationale for using cable-stayed technology. We base this technology on several other existing structures.

Main Hall Acoustics

One of the key characteristics of a concert hall that greatly influences sound quality, is its reverberation time (the time before the decay of the reflected sound ). In the construction of the main hall for the CSU Performing Arts Center a balance will be determined that will create a reverberation time of two seconds, as independent of audience size as possible.

In this section, we discuss the materials to be used. Retractable banners will be built into the ceiling, and can be lowered to create this effect. Cloth seats will be used as they best assimilate an occupied audience area ( Beranek 1962 ). This allows sound within the hall to be independent of audience size. The low sound absorbency of plaster also makes it ideal for the creation of the desired reverberation time of two seconds.

The intensity of the direct sound should not be too weak, but at the same time, it must not become uncomfortably loud. This problem will be dealt with by limiting the length of the room, and by designing the surfaces above and around the stage to project the sound evenly throughout the concert hall. Another problem arises with the seats placed under a balcony. To prevent a muddiness within the sound, the depth under the balcony should not exceed the height of the opening beneath the balcony.

The Colorado State University Performing Arts Center consists of three levels. The total area of the complex is 56,500 square feet. The basement and ground floors consist of 20,500 square feet apiece. The second floor has a square footage of 15,500.

During the duration of the project, we accomplished our goal of designing a Performing Arts Center for the CSU campus that would blend well with the rest of the campus. A cable-stayed support system for the roof will allow for a compact facility and an unobstructed view for patrons. In order to achieve the best acoustical results in the main performance hall, we have designed a rectangular hall made of plaster. We have also designed the hall so that the depth under the balcony does not exceed the height of the opening beneath the balcony. The total area of the complex will be 56,500 square feet split into three levels. The main hall will have a seating capacity of 1,200.

Introduction: You don't need to summarize the paper's introduction since the introduction is generally an overview to the whole report. In other words, don't summarize what you're going to summarize.

Executive Summary: This summary is too short compared to the report's length.

Location: This information doesn't tell me squat. They should have said something like, "This report presents the location at the northwest corner of the Oval as being the ideal location. The motivation for this decision is documented in this section." This is a summary. Summaries should inform me; they shouldn't tell me what I'm being told.

Main Hall Acoustics: This section is more informative. Here, they tell me the key characteristics influencing sound quality. As for the phrase "It will be determined," well, hasn't it already been determined? They should have written, "In the construction of the main hall for the CSU Performing Arts Center, a balance of x was defined. This creates a reverberation time of two seconds." You need to positively say what's been done. In other words, you did this, you designed it.

Conclusion: You should only summarize the conclusion if it's really a conclusion and not a summary. By this I mean have you come to a conclusion? Based on everything you've done, have you made conclusions or recommendations and not summarized what you've covered in the report?

Acknowledgments................................i

Abstract..............................................ii

Executive Summary.............................iii

List of Figures..................................iv

List of Tables....................................v

Introduction.........................................1

Location..............................................3

Cable-Stayed Technology.....................5

Acoustics............................................8

Floor Plans........................................12

Conclusion........................................16

References.......................................17

First of all, I like the dots that make the visual connection. This report does not go into much in the way of subsections, and so from that standpoint, it is probably appropriate not to number the sections. This table of contents doesn't use subsections, which is adequate for the length of this project. I'm expecting a more detailed table of contents this year. I'd like to see further subsections on ideas. That helps writing be more organized.

Example of Table of Contents with Subsections:

1.0 Introduction..........

Here, the main topics are at one level, then indented to the next level. And they're just great visual clues. One of the purposes of the table of contents is to give readers a visual map of the document. They can look at this before they start reading and know where things fit. Writers need to think of a table of contents as providing a mental map for readers.

List of Figures

The captions on this list are weak, and this is obvious because of the phrases, "Map of Campus," "Bridge Diagram." There's no use of capitalization because they're just phrases. This is a balancing act. You don't want to write long sentences, but you don't want to write something that's so vague readers aren't certain what it means. For example, a reader might ask "What campus?" The students are obviously thinking in their own minds of one campus, CSU. They need to think beyond that. One of the things I try to impress on students in figures and tables too, is that sometimes these will be pulled out of your report. And so now, they're out of context. You've got to balance giving enough information, so someone can interpret it when it's out of the context of the existing report. Captions should not be so overly verbose that you've got a paragraph. I think a figure caption should be about one line at the most. At times captions may get a little longer, but I find those distracting.

The purpose of designing a performing arts center on the CSU campus is to provide adequate capacity and higher quality of sound and aesthetics as compared to the existing structures in the region. Factors that MASK Engineering considered included accessibility, cost effectiveness, location, and an efficient use of space. Our intent was to preserve the open space of the CSU campus and to design the complex in such a manner that it will blend well with its surrounding environment.

We at MASK Engineering believe that this project will greatly benefit both the CSU campus and the surrounding Fort Collins community. Such a facility will lead to the improvement of the performing arts programs on campus. It will directly affect the students and professors in the music, theater. and dance programs at the university, eventually increasing enrollment in these disciplines. There are approximately 230 students in the performing arts programs at CSU right now. The amount of space that is available to these students is inadequate for their performances. The construction of this complex will not only provide them with the space they need, but will also continue the growth of these programs, making CSU a leader in the education of the performing arts.

These changes at the university will result in a heightened cultural awareness in the community. Currently, community events are held at the Lincoln Center, while CSU sponsored events are held at the Lory Student Center theater. A new facility will bring community and university events together and will allow a greater variety of outside events to be brought to Fort Collins. The location of this complex on campus will bring a greater number of students to these events due to the elimination of transportation problems.

MASK Engineering has focused on the structural and acoustical aspects of the CSU Performing Arts Center, while hiring other firms to handle the parking, mechanical and electrical operation, and utilities. A cable-stayed support system has been chosen, and a floor plan has been drawn up that will produce the best acoustical results. A. L. handled the acoustical aspects of the complex, while S.C., K.N., and M.B. concentrated on the structural plans. We are planning for the construction of this complex to begin within the next few years.

The site chosen for the Colorado State University Performing Arts Center is the plot of land upon which Green Hall now stands (Figure 1). This area was chosen primarily for its location on the CSU campus and its proximity to the downtown area. Green Hall is a condemned building and is not currently used for anything beyond university storage. Some office space has been granted to the branch of the CSUPD dealing with parking violations, but this department could easily move back to its old location at Aylesworth Hall. Our firm believes that this space would be better used as a home for the performing arts than as the site of a crumbling warehouse.

We have considered possible disturbances that the construction of the performing arts center on this plot might cause. Due to the close proximity of Green Hall to Allison Hall and Parmelee Hall, we have decided to begin construction early in the summer, after classes have ended. Green Hall will be torn down first, and construction of the performing arts center will begin immediately. This will allow us a good start on the project while students are not living in the nearby residence halls. According to the front desk at Braiden Hall,, which is located near the Morgan Library construction site, residents do not have a problem with noise and there have been no complaints of disturbances. MASK Engineering believes that this will be the case for the residents in Allison and Parmelee when they return in the fall as the performing arts center is finished.

A cable-stayed support system was chosen for the design of the CSU Performing Arts Center. One reason for choosing this system was to allow for a more compact facility because the space available on campus was limited. Another reason was to give patrons an unobstructed view of events by eliminating the need for columns.

The original use of cable-stayed technology was seen in bridges. German engineers established the design of cable-stayed bridges in the 1950's and 1960's. This technology was eventually adapted to buildings, using cables to support the roof. Each tower is buttressed by two sets of cables, transferring the load into the ground. Without a roof load to support, columns are not needed in the complex and the space can be used in more ways.

The concept behind cable-stayed technology is to have the supporting reactions to the load directed in only vertical directions as opposed to vertical and horizontal. It also eliminates any tension and/or compression force (Figures 3.1 and 3.2) . For a building, the load of the roof is directed through the cables, to the towers, and down to the ground. The walls do not support the roof as they normally would; only the cables are used to hold up the roof. An example of a cable-stayed building is the Alamodome, a multipurpose stadium in San Antonio, Texas (Figure 3.3). Our model is based on this design.

Background One of the key characteristics of a concert hall that greatly influences sound quality, is its reverberation time (the time before the decay of the reflected sound ). For orchestral or band music, the ideal reverberation time is approximately two seconds. Any times approaching 1.6 seconds will lead toward a dry, dead sound ( Beranek 1962 ). The other extreme is a time that is too long. This causes the music to lose its clarity, an excessive loudness, and the blending of incompatible chords ( Beranek 1962 ). A hall's reverberation time can be affected by such things as the volume of the room or the number of people in the audience. In the construction of the main hall for the CSU Performing Arts Center a balance will be determined that will create a reverberation time of two seconds, as independent of audience size as possible.

Sound quality is also greatly determined by the warmth of the sound. Warmth is determined by the fullness of the bass tones. If the middle frequencies of a sound have longer reverberation times than the low tones, then the sound will become brittle (Beranek 1962 1).

Materials Table 4.1 gives the absorption coefficients of different frequencies for common surfaces. It shows that materials such as heavy curtains or thick carpet absorb are the ideal choice for decreasing the intensity of higher frequencies. This leads to the production of a more full, warm sound. Retractable banners will be built into the ceiling, and can be lowered to create this effect. Cloth seats will be used as they best assimilate an occupied audience area ( Beranek 1962 ). This allows sound within the hall to be independent of audience size. The low sound absorbance of plaster also makes it ideal for the creation of the desired reverberation time of two seconds.

Design considerations The intensity of the direct sound should not be too weak, but at the same time, it must not become uncomfortably loud. This problem will be dealt with by limiting the length of the room, and by designing the surfaces above and around the stage to project the sound evenly throughout the concert hall. Another problem arises with the seats placed under a balcony. To prevent a muddiness within the sound, the depth under the balcony should not exceed the height of the opening beneath the balcony, as shown in figure 4.1 ( Beranek 1962 ).

Table 4.1 Absorption coefficients of different frequencies for main hall surfaces

Table based on: Beranek, L. 1966. Music, Acoustics, & Architecture. John Wiley and Sons, Inc., New York.

Figure based on: Beranek, L. 1966. Music, Acoustics, & Architecture. John Wiley and Sons, Inc., New York.

Floor Plans

The basement level of this center (Figure 5.1 ) includes two main dressing rooms with shower facilities as well as four private dressing rooms with individual restrooms for guest performers. The mechanical room for the building will be in the basement, housing such devices as the heating, ventilating, and air conditioning equipment as well as the mechanics for the elevator. A spacious performers' lounge has also been added in to the basement to provide a relaxing environment for the center's performers.

The building's main floor (Figure 5.2 ) includes the main performance hall as well as a small rehearsal hall. The main hall is 5,000 square feet and has a seating capacity of 1,200. A coffee shop and art lounge have been included in this plan for the enjoyment and convenience of the patrons. A large classroom is provided for dance classes as well as rehearsals. Sufficient office space is included adjacent to the center's box office.

The top floor of the CSU Performing Arts Center (Figure 5.3 ) includes a walk- around balcony overlooking the main lobby as well as a balcony for the main performance hall. An elevator is provided for travel between the first and second floors. A recording studio is also located on this floor as an added bonus.

In conclusion, MASK Engineering has carefully planned out the details of the proposed CSU Performing Arts Center. This facility will be a benefit to the performing arts programs at CSU, the students and faculty of CSU, as well as the members of the community. It will allow for the improvement of programs in the area and growth of interest in cultural events. The site of Green Hall will be accessible to both students and the community, and will use the space on campus most efficiently, preserving the green areas. A cable-stayed support system for the roof will allow for a compact facility and an unobstructed view for patrons. In order to achieve the best acoustical results in the main performance hall, we have designed a rectangular hall made of plaster. We have also designed the hall so that the depth under the balcony does not exceed the height of the opening beneath the balcony. The total area of the complex will be 56,500 square feet split into three levels. The main hall will have a seating capacity of 1,200. The facility contains necessary rooms to accommodate the performers, and several rooms to make the visit of the patrons more enjoyable.

Introducton: The one thing lacking in this introduction is a good, brief description of their design. The discussion about the benefits, etc. are not clear to me without first hearing what their solution is.

They do a good job of discussing the motivation for their project.

I personally like the introduction to end with a brief description of what the remaining portions of the report contain.

A little more background and possibly a map would help this discussion. DO NOT assume your reader is as familiar with this as you are.

Figure 2.1: With this figure, I'm not certain whether or not this is the caption or part of the title of the figure. This says, "Map of Campus, circle area represents the site where Green Hall currently stands." That mixes what it is. A revised caption would read something like "Map of CSU Campus Indicating Proposed Site Location."

The map also borders on plagiarism. When you take a figure from someone else's work, you put in the caption "from" and you list the document and that document better be in the references. And it's not "based on," it's "from." And that's a subtlety you need to learn. There's a distinction between something that is "from." To get permission to use this map, the writers would have to get copyright approval from the source. If they based it on, if they've redrawn the figure and they've used this map as a source, then they should, even at that point say, "based on," or "the CSU Map is from such and such source, page such and such, dated such and such." It needs to be a complete reference.

Another problem is that by looking at this map, I can't read a darn thing from it. I know that's the Oval. And I know the Weber building because I live in it. But the scale is so off, and the reproduction is so bad that they should have made the decision to either find a better original or not used it at all.

They should also include an arrow to Green Hall. The circle's not quite sufficient. The Oval isn't that different from the circle. Part of the problem is that the scale is wrong. I shouldn't have to look at a figure and guess what writers want me to see. It should be blatant.

In terms of the placement of this figure, I have several thoughts. The writers put their figures on separate pages within the body of the text. That's an acceptable style. I have no problem with that. It comes after its first reference in the text, which is important. The inappropriate thing is referring to it in the text as "figure 1," and referring it on the paper as figure "2.1."

Figures 3.1 and 3.2: These figures are labeled "Figures 3.1 and 3.2." Which one's which? They should not be put together. What I mean by this is they can be on the same page, but Figure 3.1 needs to be where Figure 3.1 is and Figure 3.2 need to be where Figure 3.2 is. The figure numbers should not both be up at the top. The reader shouldn't have to guess "is there a dividing line between the figures or does it divide some where else?" If they had captions associated with those figures' numbers, that would not have occurred. I actually like figure numbers underneath the figure, not above the figure.

With these figures I again wonder if they were taken from some source not referenced. And so, I'm not sure these are originally hand drawn by the students. Now if they are, they could have done a better job because the legends don't fully tell me what it means. The dark square means compressive force, and I don't know what that means. I understand "load" and I understand "supporting reactions," but I don't understand "Building diagram?" That's a building?

I'm not convinced these were meant to be two figures. I think they should be one. They're talking "cable stay" technology which would of been nice to have in the title. I think they're trying to draw an analogy between "here's how a bridge is done, and here's how it's also now being done in buildings." But it's not coming through.

This figure is placed at the right location. The key thing with placement in text is to put the figure as close as possible after it is first referenced. Never put it before you reference it and don't bury it deeply in the text. This is one of the clues that leads you decide whether you do an appendix or not. If you find you're having so many figures that when you try to put them in text they're turning out to be five pages straight of figures, that's a clue that you have so many figures, they're probably better handled in the back.

Figure 3.3: I know the writers didn't take this photograph! And I want to know who did take the photograph because that person needs to be credited. This figure's location in the text is fine. I'm happy with their style of one figure per page.

The quality of this reproduction is not very good. But that's always hard with photographs. It does make their point, which is the tall columns with the cables coming off. However, the fine details have been wiped away, so it's a bad photograph for their purposes.

This visual also works off the previous two visuals since it represents another way of looking at the particular structure. Whenever you can, especially when you're dealing with new technology, you've got to give people good visual images. And anyway you can do that is useful. Schematics allow you to do certain things like add arrows and show load paths. So this had a different function. The other two depicted load paths. This one was trying to give the viewer a big picture of what this looks like. After all, a bridge is difficult to imagine.

Table 4.1: This table accurately sites its source, "Table based on such and such." However, it gives too much information. All that is needed is the author's name, so readers could then look it up in the references.

Some suggestions are to put "Based on Byronic L 1966." all within the caption. Then the table would physically separate the title if I felt there was a title too, separate from the caption. It would then be clear, spatially, that there's a caption up here. And below is the title on the table.

Another alternative would be to "footnote" the table. Not a real footnote, but a footnote within the table. This can be done by using an identifier like a "star." So I might say, "Table," if it's the whole table, and put, "Table 4.1*" showing that there's a clue to come, down at the bottom. If there were particular pieces of information in here, a particular column or something, such as just the surface frequency or heavy fabric, or it was two of these, I could then put stars on there and indicate, "This was based on this person's work, as opposed to my original work.

Figure 4.1: When a figure like this needs to be drawn, you should follow normal conventions for drafting, including dimension lines with arrowheads. I'm assuming the "D" and "H" represent "depth" and "height."

A figure is for clarification, and this one raises many questions. I don't know what the point of this figure is. I'm assuming there's a value here. If this was to be a conceptual diagram representing, "We now can do a sensitivity D over H," then you might do that. But I think they were trying to show us how big is was. It's not a very good figure because it leaves too much to my imagination. This is not worth a thousand words.

Figure 5.1: A scale should be included here. Also, these should be numbered. Students should indicate how each one works (e.g. doors, etc.).

Figure 5.2: A scale should be included here. Also, is that the Performance Hall in the middle?

Figures 5.1, 5.2, & 5.3: These were done with AutoCAD, so it's hard to criticize the quality of them because this is what AutoCAD produces.

"M" and "W" should be explained; I am assuming these stand for a Mens' Room and a Women's Room. There are better visual ways of doing that more explicitly, as with international symbols, etc. Also, "E" for "exit" is a little short.

These are meant to be schematic floor plans. And they are. It'd be nice to have a "north arrow" here. Students will always think of a "north arrow" on a map, but they won't necessarily think of it on a building. It's important because it helps readers tie back to the orientation of the building on the site.

These serve very well as schematics. They do not serve well as details. They don't show doors; they don't show windows. But this design is more at the conceptual level, so I understand why they did it. The detail fits the purpose. The problem is, when readers look at this example, they don't necessarily know that whole context.

It really would have been nice to have put these visuals in the front. A neat way to have done that would have used this as a figure on the title page to introduce the concept right up front.

The captions on these are all right. If you put to much lettering on a figure, it gets busy. This is actually a pretty good balance. They're descriptive enough. I understand just about what everything is. I'm not sure what the basketball-like part is since it's not labeled. But overall, these are pretty good, typical, schematic drawings.

Using a different font is a stylistic mistake. If you have an area that you want to label and the font you're using doesn't fit in there, don't just use a real small font because it fits. Move the label out and put an arrow to it.

This is a fairly low number of references. Three is minor. Sometimes, you might not have references because much of your text is original work on your part, but then you should include appendices on calculations and such.

Appendices: When deciding to place information in an appendix, ask yourself, "Are there reams and reams of figures that are best put in an appendix or will using a small number of figures integrate better throughout the text?" and "Do I have a source document that’s very critical to the report I want to attach to it, a data report or letter that is secondary to the actual writing, but not secondary to the major issue of the report?" Much of this depends upon your interpretation. A likely source for appendices is computational results. I like to think you’re doing work, so it’s logical to do screen dumps or spreadsheet dumps of tables and calculations. The best place for these is in appendices.

Perspectives on Technical Reports

Dave alciatore, mechanical engineering.

Writing Technical Design Reports as a Group

"Often, technical design reports require that multiple experts help write them. This is called "concurrent engineering." This way, everyone involved with a project contributes. More ground gets covered this way. The report is also a good way to document a design. Then, if problems arise later, everyone can refer to the document. This helps determine where changes were made, etc."

Report Content

"Every company has different means of documentation. Typically, in industry, you won't have to provide as much history in a technical report. This is because in academia, we want you to document your thought processes and project evolution. In industry, you will concentrate more on the initial problem, requirements, and solutions. "

Neil Grigg, Civil Engineering

Multiple Reports for a Project

"Suppose your engineering task is to build a retaining wall. As the main engineer, you've got to consider many aspects: the load, the height, the structural design. You'll write a report where you state the goals and how they will be accomplished. This includes input parameters, the conditions in which you have to work, alternatives, recommendations. Next, soil engineers may actually test the soils at the location. They would then produce a report about what they found. Every project generates multiple reports. "

"Many designs begin with identifying the problem, determining the goals, and creating a list of alternatives. The next part is the evaluation. This includes the technical, legal, economic, financial, environmental, and social evaluations. Then you make recommendations based on these evaluations. Most reports, especially design reports include this information. "

Tom Siller, Civil Engineering

An Example Technical Report

"I once helped produce a report about rock fracturing for a whip site. In that report, we stated the situation, how we would analyze the situation, (because we wanted to be hired as the engineers for the project), the analytical tools we would develop, and our results based on those analytical tools. We did not present a shaft design. Overall, the report presented our way of understanding the issues that would help design a shaft."

Your Report's Purpose

"If your report's purpose is to create an artifact, then you have to present all the technical aspects of the design. This way, someone can read the report and build your artifact. You have to be aware of very fine details whenever you write a report. For instance, will your designs receive public approval? Are you in compliance with regulatory agencies? And so why you are writing the report helps you determine what details to include and exclude."

Citation Information

Dawn Kowalski. (1994-2024). Engineering Technical Reports. The WAC Clearinghouse. Colorado State University. Available at https://wac.colostate.edu/repository/writing/guides/.

Copyright Information

Copyright © 1994-2024 Colorado State University and/or this site's authors, developers, and contributors . Some material displayed on this site is used with permission.

Write a Good Technical Report

Ieee account.

  • Change Username/Password
  • Update Address

Purchase Details

  • Payment Options
  • Order History
  • View Purchased Documents

Profile Information

  • Communications Preferences
  • Profession and Education
  • Technical Interests
  • US & Canada: +1 800 678 4333
  • Worldwide: +1 732 981 0060
  • Contact & Support
  • About IEEE Xplore
  • Accessibility
  • Terms of Use
  • Nondiscrimination Policy
  • Privacy & Opting Out of Cookies

A not-for-profit organization, IEEE is the world's largest technical professional organization dedicated to advancing technology for the benefit of humanity. © Copyright 2024 IEEE - All rights reserved. Use of this web site signifies your agreement to the terms and conditions.

Utah State University

Search Utah State University:

Technical writing standards, style and format.

When writing technical documents, engineers rely on style manuals, which provide standards for writing and designing documents. Style manuals ensure consistency in writing and formatting documents written for academic or workplace communications.

Academic disciplines, including academic journals, have their own style manuals. These style manuals are used in the production of theses, dissertations, or journal articles.

Organizations use company-specific style manuals that contain guidelines for producing technical documents, business correspondence, professional presentations, and visual features (trademarks and logos). Document format and punctuation rules are commonly found in these style manuals. Company-specific style manuals often contain templates, which are used when creating written technical documents (progress or status reports, design reports, proposals, etc.), correspondence (letters, memos, and emails), or presentation slides.

General Format Guidelines

The following guidelines represent generally accepted technical writing guidelines. As a reminder, guidelines may change based on the discipline, professor, employer, or journal the document is written for.

Technical documents typically contain:

  • Single spacing
  • Left justification; full justification is preferred for theses, dissertations, and journal articles.
  • One blank line between paragraphs OR indented paragraphs with no blank line between
  • Serif font (Times New Roman), 12 pt. font size. When documents are written for electronic media, however, a Sans Serif font (Calibri or Arial) is typically used.
  • One-inch margins. Margins may need to be adjusted when using company letterhead or when binding formal reports.

Stylistic Elements

Writers of technical information take into account the audience’s level of knowledge regarding the topic and the purpose of the document. In other words, “Why does the reader need this information and what will they do with it?” The following guidelines help writers achieve a readable style.

Acronyms and Abbreviations

Abbreviations are shortened forms of words such as ASME for American Society of Mechanical Engineers. Acronyms are formed when the abbreviation forms a pronounceable word such as NATO for North Atlantic Treaty Organization.

Abbreviations and acronyms should be spelled out the first time they appear in a technical document with the shortened form appearing in parentheses immediately after the term. The abbreviation or acronym can then be used throughout the paper.

Example: The Society for Technical Communication (STC) is a professional association dedicated to the advancement of technical communication, content, and information management.

Common abbreviations (U.S.) or acronyms (NASA) do not need to be spelled out when first used in a document.

Ambiguity occurs when words or passages can be interpreted in more than one way. Abstract language, misplaced modifiers, and vague pronoun reference can cause ambiguity. To make writing clear, avoid:

  • abstract language ( really, quite, severely, very )
  • overusing pronouns, particularly it, these, and this
  • imprecise or subjective terms ( fast, slow, tall, small )
  • words that have no precise meaning ( bit )

Analogies and Metaphors

Analogies and metaphors in useful in technical writing to illustrate abstract or complicated ideas by making comparisons between two generally unlike things.

“When two atoms approach each other at great speeds, they go through one another, while at moderate speeds, they bound off each other like two billiard balls.” Sir William Bragg

Writing with the intended audience(s) in mind is one of the most fundamental concepts of technical writing. Many technical documents will not only be read by the first person (primary audience) but may also be read by secondary audiences: readers in various levels of management, prospective financiers, or even individuals who access information without the writer’s knowledge.

For this reason, it is important to consider who may read your documents beyond the primary audience and write with any additional audiences in mind. This means targeting information appropriate for the knowledge of the audience(s) and using accessible language that both technical and non-technical audiences can understand.

Cliches, or figures of speech, are terms that have no concrete meaning and can affect the tone and professionalism of a document. Cliches should be avoided in technical writing. Examples include:

  • water under the bridge
  • writing on the wall
  • easier said than done
  • close the deal

Conciseness

Concise documents convey meaning using the fewest words possible without sacrificing meaning or clarity. To achieve conciseness:

  • Eliminate empty/wordy phrases ( there is/are and it is ). These are considered to be indirect phrases and tend to be unclear and wordy. Direct statements, on the other hand, are clear and concise. Instead of: “There are 25 students who have already expressed interest in next year’s program.” Use: “Twenty-five students have already expressed interest in next year’s program.”
  • Write using the active voice Instead of: “It was determined that the machine was broken by John.” (10 words) Use: “John broke the machine.” (4 words)
  • Avoid using weak verbs Instead of: My recommendation is for a larger budget. Use: I recommend a larger budget.
  • Eliminate filler words (very, quite, really, somewhat, that)

Contractions

Contractions are shortened forms of words with the missing letters represented by an apostrophe such as “you’ll” for “you will” or “didn’t” for “did not.” Contractions are unprofessional and informal and should be avoided in most technical documents.

Generalized Statements

Generalizations are broad statements or ideas that are applied to a group of people or things and should be avoided in technical writing. These statements are difficult to substantiate and are too broad to be supported.

The only way to learn another language is to visit the country where it is spoken.

Cats are nicer than dogs.

Gender-Neutral Terms

Avoid specifying gender when possible. Gender specific language can create stereotypes, make generalizations, and exclude gender. Individuals should not be referred to solely as he or she . To achieve gender neutrality:

  • Use generic terms when referring to specific groups of people (“supervisors”)
  • Avoid gender-specific pronouns (“his” or “her”)
  • Use gender-neutral titles when referring to people “(sales representatives” not “salesmen”
  • A student should always do his homework. (not gender neutral)
  • A student should always do his or her homework. (gender neutral)
  • Students should always do their homework. (gender neutral)
  • A student should always do their homework. (gender neutral) *

*While it may seem strange or incorrect to use the plural their to refer to a single student, their has become the preferred replacement in many places in order to ensure gender neutral language. It is no longer considered grammatically incorrect to use their as a singular pronoun in this context.

In technical reports, headings are used to organize documents, guide the reader, and break content into manageable chunks of information. Readers often peruse headings and read those sections that pertain to them.

Headings organize content into large sections (major headings) and then into smaller sections (sub-headings). Headings are formatted by level (first level, second level, third level, etc.) and vary in their position and formatting. Discipline- and employer-specific style manuals will provide guidelines in the placement and visual layout of headings. Headings vary in the type of information they provide:

  • Brief topic headings use short words or phrases Example: College Applications
  • Statement headings use sentences or phrases and are more informational in nature. Example: College Application Process
  • Question headings are useful when writing documents that explain how to do something. Example: How do I Apply for College?

When using headings:

  • Construct headings in a parallel fashion
  • Try to avoid starting headings with a, an, or the
  • Aim for at least two headings at each level; avoid dividing a section into a single sub-section if possible
  • Avoid repeating the wording of a higher-level heading in a sub-heading
  • Use headings to create the table of contents (if applicable to the document)

Jargon is often called professional slang and consists of terms specific to a particular organization. Examples of jargon include terms like “flame” or “FUBAR.” Jargon sets members of an organization apart from non-members. When communicating with individuals who are likely to be unfamiliar with jargon, avoid using the term.

Lists are useful in technical writing for three purposes: to write a series of related items, to describe a series of tasks, and to make items visually accessible. Lists can be written in a sentence (as in the previous sentence) or set off from the text vertically. Items listed vertically are prefaced with a bullet, number, or checkmark. Bulleted lists make items easy to see or locate, numbered lists organize steps in a process, and checklists communicate items that need are required or need to be completed.

Lists are prefaced with a lead-in phrase ( Items to review for the training: ) or sentence ( The following topics will be reviewed at the training: )

Key points to keep in mind when creating lists:

  • Lists should be constructed in a parallel fashion.
  • Lists comprised of brief items typically contain no ending punctuation.
  • Lists with no sequence required should be arranged logically (most to least important, alphabetical)
  • Lists written as full sentences should use appropriate ending punctuation.

Narration (Point of View)

When writing, it is important to use appropriate tense and narration. Engineers often write to explain how something happened: a lab procedure, a site visit, an accident, a recommendation.

Third person narration is most often the appropriate choice in technical documents and academic journals, but in some cases it might be appropriate to use first or second person (common in business correspondence).

Examples: First person narration , “I” words are used. I should get good grades in college. We should get good grades in college. Second person narration , “You” words are used. You should get good grades in college. Third person narration , “he/she/neutral” words are used. A student should get good grades in college.

Students should get good grades in college.

Objectivity

Technical documents present facts, data, evidence, calculations, results, and theories, which must be presented in an impersonal, neutral, and objective manner. Avoid use of the word “feelings” or the verb “feel” in technical writing.

Phrases such as “I feel this is the best approach” evokes emotion, is not objective, and can lend uncertainty to technical writing. Similarly, “When the weight feels right” should not be used in describing inanimate objects.

Paragraphs are the building blocks of documents. It is important to keep in mind the basic elements of paragraph construction: each paragraph should contain a topic sentence that is well-developed and supported, discuss one idea, and transition to the next paragraph.

In technical writing, paragraphs are generally kept to 4-6 lines. Short paragraphs emphasize main ideas, encourage conciseness, keep the reader’s attention, and break up content into manageable chunks.

Parallelism

Parallelism means using the same structure for listed items. These items can occur in a sentence, in a table, in a bulleted or numbered list, or in headings. Sentences with parallel structure are easier to read and flow more smoothly.

When creating a bullet list, all items in the list should be parallel in construction.

Redundancy means using two or more words that essentially mean the same thing. Redundancy affects conciseness.

  • a new innovation
  • absolutely true
  • red in color
  • cylindrical in shape

SI versus Customary Units

Systeme Internationale (SI) units are the most widely and officially recognized system of metric units for weights, dimensions, and other physical measures in technical writing. Technical documents should use SI units in text, figures, tables, and equations.

Sentence Length

In technical writing, uncomplicated sentences are used to state complex ideas. Long, complex sentences tend to confuse readers. Strive for a sentence length of 10-20 words. A document should not be constructed, however, of short, choppy sentences. Varying sentence length can encourage readability, make comparisons, and contrast information.

Technical Terms and Definitions

When introducing a technical term in a document, italicize and provide a brief explanation of the term the first time it is used. There are generally three types of technical definitions: informal, formal, and expanded.

Informal definitions contain a word or brief phrase, often in parentheses, that gives minimal information about the term.

“At the southwest corner of the mall site, we found 16 barrels of creosote (a coal tar derivative) buried under three feet of sand.”

Formal definitions are typically a full sentence that distinguishes the term from other similar terms and includes the term itself, a class to which the term belongs, and distinguishing feature(s) of the term, which typically describe what the term does.

If the technical term has unclear or multiple meanings, add a qualifier to the beginning of the definition.

Tone refers to the feeling or attitude a document evokes; tone can also portray how the writer feels about a subject. Tone can be dependent on the purpose, audience, or medium of the message. Strive for neutral, professional, understandable words. Because engineers deal with complex information and terminology, word usage should be accessible and familiar.

Voice (Active or Passive)

Voice refers to how verbs are used in sentences. Although passive voice has long been a hallmark of technical writing, writing in the active voice is a preferred practice. Active voice makes documents more readable by making sentences more clear and concise. Passive voice is still used for certain types of technical documents such as lab reports.

When the verb is in the active voice, the subject performs the action; when the verb is used in the passive voice, the subject receives the action.

The boy hit the ball.

The ball was hit by the boy.

Hint: Watch for phrasing patterns common to passive voice: “was (verb)ed by….”

Use active voice when:

  • writing most technical documents.
  • writing needs to be concise, clear, and direct.
  • it is important to know the “doer” of the sentence.

Use passive voice when:

  • the genre (format) calls for passive voice (lab reports)
  • the action itself is more important than who or what performed the action or when the doer of the action is unknown.

Word Choice

Words should be used that are accessible and familiar to your audiences, both primary and secondary. This means using a shorter, more well-known word in place of a longer, less-known word with the same meaning.

Library homepage

  • school Campus Bookshelves
  • menu_book Bookshelves
  • perm_media Learning Objects
  • login Login
  • how_to_reg Request Instructor Account
  • hub Instructor Commons
  • Download Page (PDF)
  • Download Full Book (PDF)
  • Periodic Table
  • Physics Constants
  • Scientific Calculator
  • Reference & Cite
  • Tools expand_more
  • Readability

selected template will load here

This action is not available.

Humanities LibreTexts

Chapter 1: Introduction to Technical and Report Writing

  • Last updated
  • Save as PDF
  • Page ID 179209

Bay College

Learning Objectives

What is Technical Writing? [1]

You’re probably wondering what this “technical writing thing” is. Someone may even have told you, “It’s this course where they make you write about rocket science and brain surgery.” Well, not really, as you will see in a moment. Actually, the field of technical communication is essential in a wide range of fields and occupations. It is a fully professional field with degree programs, certifications, and—yes!—even theory. It’s a good field with a lot of growth and income potential; and an introductory technical-writing course for which this book has been developed is a good way to start if you are interested in a career in this field .

Technical writing is an audience-centered means of communication that provides a reader with clear and easy access to information. In the business world, time equates to profit, and profit is the force behind all business interaction. The technical writer and reader have a vis-à-vis relationship. The writer recognizes, respects, and addresses the importance of time in effective and efficient communication by providing documents written in specific formats, using unambiguous language to send clearly accessible information. The reader in turn thoroughly understands the information in order to give a thoughtful response.

The Meaning of “Technical”

Technical communication—or technical writing, as the course is often called—is not writing about a specific technical topic such as computers, but about any technical topic. The term “technical” refers to knowledge that is not widespread, that is more the territory of experts and specialists. Whatever your major is, you are developing an expertise—you are becoming a specialist in a particular technical area. And whenever you try to write or say anything about your field, you are engaged in technical communication .

Academic Writing Versus Technical Writing

The definite purpose, strict format and use of appropriate language in technical writing define the differences between technical writing and academic writing. The academic writer’s purpose may be to write an assignment, a story, a letter, etc.. These works may or may not have a reader. However, technical writing always has a definite purpose and will always have a reader. Regardless of the number of the intended readers of a document who may or may not read the document, the document will be read by the primary reader.

Workplace Writing

However, the focus for technical-writing courses is not necessarily a career as a technical writer but an introduction to the kinds of writing skills you need in practically any technically oriented professional job. No matter what sort of professional work you do, you’re likely to do lots of writing—and much of it technical in nature. The more you know about some basic technical-writing skills, which are covered in this guide and in technical-writing courses, the better job of writing you’re likely to do. And that will be good for the projects you work on, for the organizations you work in, and—most of all—good for you and your career .

Really Technical Writing

Keep relaxing, but you should know that professional technical writers do in fact write about very technical stuff—information that they cannot begin to master unless they go back for a Ph.D. But wait a minute! The technical documents have to ship with the product in less than nine months! How do they manage? Professional technical writers rely on these strategies to ensure the technical accuracy of their work:

  • Study of books, articles, reports, websites related to the product
  • Product specifications: what the product is supposed to do, how it is designed
  • Interviews with subject matter experts: the product specialists, developers, engineers
  • Product meetings during the development cycle
  • Live demonstrations of the product
  • Familiarization with similar, competing products
  • Experimenting with working models of the product
  • Most importantly, subject matter experts’ review of technical writers’ work for technical accuracy and completeness

Of course, experienced technical writers will tell you that product development moves so fast that specifications are not always possible and that working models of the product are rarely available. That’s why the subject matter experts’ review is often the most important.

Considerations of Technical Documents

There are key components of what makes a document strong. Therefore, writers keep these items in mind while constructing technical documents.

The Importance of Audience

Another key part of the definition of technical communication is the receiver of the information—the audience. Technical communication is the delivery of technical information to readers (or listeners or viewers) in a manner that is adapted to their needs, level of understanding, and background. In fact, this audience element is so important that it is one of the cornerstones of this course: you are challenged to write about highly technical subjects but in a way that a beginner—a nonspecialist—could understand. This ability to “translate” technical information to non-specialists is a key skill to any technical communicator. In a world of rapid technological development, people are constantly falling behind and becoming technological illiterates. Technology companies are constantly struggling to find effective ways to help customers or potential customers understand the advantages or the operation of their new products .

Not only is the the level at which you write important but so are the language choices you make as you do so. Please review the information on the following link for tips: Use Language that is Sensitive to Your Audience [2]

So relax! You don’t have to write about computers or rocket science—write about the area of technical specialization you know or are learning about. Also, plan to write about it in such a way that even Grandad can understand !

Formatting and Language

Formatting and appropriate language are the basic design elements of all technical documents. A format that shows a hierarchical structure and a coordinate structure of information le ads the reader thorough text.

Textbook image

Readers should be able to identify a writer’s organizational pattern very quickly when reading a technical document . This sometimes refers to a document being “reader friendly.” In addition , using appropriate language is significant in providing the reader with a thorough understanding of the purpose of the document, how the document relates to the reader’s needs, and what action is expected of the reader. [3]

A document may also have one reader (the primary reader) or several readers (the secondary readers). A primary reader is the person who ordered the report to be written or the person for whom a report is intended. These readers will usually read the entire report. Secondary readers are those readers who will read only the sections of the report that relate to them, their jobs, their departments, responsibilities, etc. For example, if a report was sent that detailed funding for different departments, a piping superintendent may only want to read the section that relates to piping. This is where format, the use of headings, is significant in allowing the reader easy access to information. When the piping superintendent can scan through the document and clearly find the heading that identifies his department saves time.

Cultural Communication

Technical writers need to be aware of the differences between the behavior and the norms, beliefs and values of specific cultural. According to Edward T. Hall and Mildred Reed Hall, In Understanding Cultural Differences, each culture operates according to its own rules (1990, pp. 3-4). Hall and Hall add that problems occur when members of one culture apply the rules to another culture (1990, pp. 3-4). To communicate effectively with other cultures, the technical writer needs to not only be aware of rules governing behaviors that can be observed but also of the not-so-obvious rules that govern the norms, beliefs, and values of the people of a culture. The invisible rules of a culture dramatically impact the acceptance of ideas, plans, and strategies. The Cultural Iceberg illustrates patterns of world communication, showing indicators of Institutional Culture (the obvious behavior of a culture), which can be clearly seen as the tip of the iceberg, and People Culture (the norms, beliefs and values of a culture), which cannot be seen and which are the barriers to successful communication .

Figure 2 The Cultural Iceberg

tech report writing document

Technical writers have a responsibility to their readers and to their employers to follow ethics when writing reports.

Law and Ethics Text with Watch

Technical writers must use words that demonstrate valid appeals to reason, avoiding emotional words and phrases that appea l to basic emotion instead of justifiable reasoning. In addition, technical writers must use valid references to support ideas and strategies, avoiding referencing non experts to sway readers’ support. Also, technical writers must use accurate numbers to report data, avoiding charts and tables that skew data. Using any type of fallacies in technical writing is unethical and could result in dire consequences.

Not only do technical writers have a responsibility to report accurate information, but they also have a responsibility to credit accurate sources of information. At no time is it acceptable to rearrange information in order to attempt to indicate that the writer is the source of someone else’s idea or to indicate that the writer read a report that included information he/she cited, when the primary source of the information was cited in another report. All sources must be referenced accurately in the text and cited on a reference page.

Daniel G. Riordan (2005), in Technical Report Writing Today, cites Dombrowski to define three threads of ethics:

One major thread is that the communicator must be a good person who cares for the audience. Communicators must tell the truth as convincingly as possible, because truth will lead to the good of the audience. Another thread is that the communicator must do what is right, regardless of possible outcomes. A third thread is that communicators must act for the greatest good for the greatest number of people (p. 16) .

In addition, Riordan (2005) references the “code of ethics of the Society for Technical Writers, and cites five of the code’s tenants:

My commitment to professional excellence and ethical behaviors means that I will …

  • Use language and visuals with precision.
  • Prefer simple direct expression of ideas.
  • Satisfy the audience’s need for information, not my own need for self-expression.
  • Hold myself responsible for how well my audience understands my message.
  • Report the work of colleagues, knowing that a communication problem may have more than one solution (Riordan, 2005, pp. 15-16) .

Hall, E. T. & Hall, M. R. (1990). Understanding Cultural Differences. Yardmouth: Intercultural Press, Inc.

Riordan, D. G. (2005). Technical Report Writing Today. Boston: Houghton Mifflin Company.

Visuals & Readability

To make a document more reader friendly, many technical writers rely on visuals to achieve this goal. [5] For example , la bels, callouts and captions are identifying text for graphics . Labels and callouts identify specific elements or features on a graphic; whereas captions are short phrases or sentences that describe the graphic. Notes, or footnotes, explain, or give credit.

Labels and Callouts

To identify specific elements or features, labels and captions are placed directly on the graphic or near it. “Although the terms are used interchangeably, labels are text identifiers that are self-explanatory in an image, while callouts are labels that require further information outside the image to explain what they are identifying” (Gurak 304). They supplement the visual information. But use them selectively; use them only if readers need them (Rude 116).

The advantage of labels is that the reader gains a basic understanding of elements in the graphic without referring to supplementary explanations. But, too many labels obscure the image. In this case, callouts are the better option. Use numbers or letters to identify each element and the supplementary explanations.

Guidelines for Creating Labels and Callouts

  • Determine the number of items to identify in the image (Gurak 308).
  • Estimate how much explanation each item requires to determine if labels or callouts are more appropriate (Gurak 308).
  • create a consistent visual style (Gurak 308)
  • use the same terms on the label or callout as in the text (Rude 116)
  • in general, all parts mentioned in the text should have a label or callout, and all parts with a label or callout should be mentioned in the text. (Rude 116)
  • Use a standard font and size for readability (Rude 116)
  • Align the labels and callouts for a neater appearance (Rude 116)
  • If callouts are used, place the explanatory text in a key next to the graphic.

Labels can take different forms (Gurak 304 – 306):

  • They may be placed directly on the graphic (whereby they become part of the graphic).
  • They may be placed around the graphic and use lines to point to the relevant element in the graphic.
  • Online, labels can be links or hotspots whereby more information about the element is displayed on mouse rollover.

This is an example of l abels placed directly on the graphic.

Map of Central Park with labelled streets and park areas.

Figure 3 Map of the West Side Central Park, NYC between 102nd and 110th Streets.

Here, the labels are placed around the graphic.

Drawing of a flower with all parts labelled with lines to their placement on the drawing.

Figure 4 Parts of a flower.

In this sample, when the mouse is rolled over the ‘Firebox’ label, the text will read: “Literally a box containing the fire. It is surrounded by water on the top and all sides. The bottom is a grate with an ash pan below that.” Additional information is displayed .

Anatomy of a steam locomotive. Each part of the train is labelled with a line to the part.

Figure 5 Labels as hotspots.

Callouts are best used when many parts of the image need to be labeled and each part requires a longer explanation. In fact, the label sequence may be in alphabetical or numerical (as in Figure 6) order. Ensure that the explanation is near the graphic.

Sample Nutrition Facts label from Macaroni and Cheese. Call outs on the left side point to different parts of the label, such as Start Here, Check Calories, Limit these Nutrients, Get Enough of these Nutrients, Footnote, and the Serving Size.

Figure 6. How to understand and use the Nutrition Facts Label.

Coded callouts are in numerical sequence; the explanation for each number appears below the graphic. The example above shows part of the explanation of Number 1 explanation only.

Captions, table, and graphics titles must clearly identify information to the reader. Interpretive captions usually require one or more sentences. Captions should be informational, without becoming too lengthy. Captions that are merely a title for a graphic are not very helpful (Franklin 96).

Writing Style for Captions

  • Captions for graphics include the title and any explanatory material, immediately under the graphic.
  • Words such as Figure, Illustration, and Table should be in bold type.
  • The caption should be italicized.
  • Treat tables and figures the same.

Good captions are what guide readers not only to see, but also to understand. Captions label graphics with titles and explain to readers what they are seeing, and how to interpret the information captured in the visual. The Franklin Covey Style Guide for Business and Technical Communication provides an excellent source for writing captions (Franklin 39 – 41).

Five Specific Style Rules

  • Use interpretive captions whenever possible. I nterpretive captions provide both a title and explanatory information, usually expressed in a complete sentence, to help readers understand the central point(s) that the writer wants to convey. A graphic and its caption should be clear and understandable without requiring readers to search for clarifying information in the text:
  • Figure 4. Cabin-Temperature Control System. Constant cabin temperature control is maintained by the system’s modulated cabin sensor.
  • This interpretive caption gives the title and then tells the reader the principle message – that the check valve provides near-zero risk. And, it states how the check valve provides near-zero risk (Franklin 39).
  • Figure 23. Check Valve . The risk of bad air entering the changer is near zero because the check valve permits air flow in one direction only.
  • This interpretive caption gives the title of the figure and emphasizes that the cabin has a constant temperature – a benefit provided by the feature described in the figure. The caption states clearly what the writer wants the reader to learn from the drawing (Franklin 39).
  • Avoid using short, often ambiguous, titles to replace interpretive captions. In the past, styles for technical and scientific documents used only short, simple title captions for visuals. These were often superfluous, providing no real information other than the obvious to the reader, i.e. – A Horse. Titles that are so short and cryptic that they sound telegraphic are not useful. Such captions are only useful when the graphics are self-explanatory, and require no interpretation (Franklin 40).
  • Number figures and tables sequentially throughout the document, and place the number before the caption. If an important figure or table is presented twice, treat it as two separate visuals and number each. Figure and table numbers should be whole numbers (Franklin 40).
  • Captions may appear below or above a visual, but consistency throughout a document is critical. Arguments support both options; choose one, warrant your choice, and be consistent.
  • Put the caption above the visual for better visibility when captions are used with slides and other project visual aids. Captions placed at the bottom may be blocked by the heads of those seated in front (Franklin 99).

Notes or footnotes are categorized as either explanatory or source notes. Explanatory footnotes are identified by a superscript number or letter. The order in which notes appear is important; explanatory footnotes are placed above source notes. And both are placed above the caption, if the caption is placed at the bottom of the illustration.

A pie chart about Toxic Chemical Releases. Below the chart, a footnote is listed with a source note and caption.

Figure 7. Placement of footnote, source note and caption.

Source: Rude, p. 115, modified.

The Writing Process [6]

Writing, especially when compiling a larger document, is not something you sit down, complete in one session, and quickly submit. This is especially true when writing for the workplace where accuracy and clarity are necessary. In fact, writing should be seen as a process that is recursive where the writer moves in and out of various stages of writing and often times revisits some of the stages. The writing process might consist of the following:

This is the planning done before writing a document. It may be defining the purpose of the task, analyzing the primary and secondary readers, sketching the document and what will go in each section, or gathering research.

This is writing and compiling a first draft of the document. Sometimes, the writer worries more about getting ideas down more than guaranteeing every punctuation or grammar choice is correct.

When a writer revises, a writer revisits the draft and makes substantial changes to it. This is more than editing. It is adding, deleting, and moving entire sections of the document around to prepare it as a final, comprehensive document. In fact, it is here that many writers ask others for feedback before revising to ensure that another, unbiased set of eyes have looked over the document and easily understand it.

This is the final part of the process. It is reading through the document several times while looking for clarity, consistency, and accuracy. In fact, consider reading your document aloud and listening to it as you do so instead of reading and “seeing” it. Most individuals communicate mostly through talking and listening. Therefore, when you read aloud, you can hear if something in your document doesn’t sound right and then correct it. You should be able to read it in a way that it is understandable and sounds conversational.

For additional information on the writing process, visit The Writing Center website for the University of Texas: University of Texas Writing Center & The Writing Process .

Using a process in the workplace and in our class will strengthen your documents significantly. In fact, remember that your documents reflect on who you are as student, technical writer, employee, and even researcher.

[1] Technical Writing. Authored by : Dr. Elizabeth Lohman. Provided by : Tidewater Community College. Located at : http://www.tcc.edu/ . Project : Z Degree Program. License : CC BY: Attribution , edited by Amber Kinonen , edits included in italics

[2] Use Language that is Sensitive to Your Audience. Provided by : Writing Commons. Located at : http://writingcommons.org/open-text/collaboration/143-common-comments/word-choice-/575-use-language-that-is-sensitive-to-your-audience . License : CC BY-NC-ND: Attribution-NonCommercial-NoDerivatives edited by Amber Kinonen , edits included in italics

[3] Image of Textbook. Authored by : Dominik Wagner. Located at : https://flic.kr/p/eoAvCb . License : CC BY: Attribution

[4] Image of Text with Watch. Authored by : Stephen Wu. Located at : https://flic.kr/p/tZ1LP . License : CC BY-NC-ND: Attribution-NonCommercial-NoDerivatives

[5] Norbert Elliot’s “Labels, Callouts, Captions and Notes” CC-BY Saylor, edited by Amber Kinonen , edits included in italics

[6] The Writing Process CC-BY Amber Kinonen

Icon for the Creative Commons Attribution 4.0 International License

Chapter 1: Introduction to Technical and Report Writing by Bay College is licensed under a Creative Commons Attribution 4.0 International License , except where otherwise noted.

  • Skip to main content
  • Skip to search
  • Sign up for free

tech report writing document

Creating effective technical documentation

Author avatar

Effective feature documentation is important in enhancing a user's experience with the feature. Good documentation is like a piece of the puzzle that makes everything click — the key for encouraging feature adoption.

To support you in creating effective technical documentation, this article provides an overview of the core principles of technical writing. It also highlights the best practices for creating clear and accessible documentation. Applying these technical writing principles helps us maintain the high quality of content on MDN. Whether you're documenting your own project or product or contributing to technical content in various settings, you can improve the quality of your work by following these best practices.

Adopt clarity, conciseness, and consistency

These three Cs form the core principles of technical writing. They can take you a long way in producing quality documentation.

For achieving clarity in your writing, apply the following guidelines:

  • Use simple words and clear language. Keep in mind the audience, especially if it includes non-native English speakers.
  • Be clear about who needs to perform the action. Writing in active voice is not strictly required. However, you should use it when you want to be clear about who needs to perform the action. For example, clarify whether a function is triggered by an event or if the user needs to explicitly call the function.
  • Clearly introduce and explain new terms. This helps to lay the foundation for concepts that are covered later in the documentation.
Tip : Replace "it", "this", and "these" with proper nouns if they can refer to more than one thing in the given context.
  • Aim for one idea per sentence to improve readability.
  • Stick to one main idea per paragraph. Each sentence in a paragraph should logically connect to the one before it. Imagine if each sentence in a paragraph was a link in a chain. If you pick up the first link, the other links in the chain should follow, forming a continuous sequence. This is how the sentences should connect to each other, ensuring a seamless flow of a single idea.

Conciseness

Keep sentences short. This automatically increases the readability and clarity of your document. It also helps in quick comprehension. Long sentences can be more challenging to understand quickly due to their complex structures.

Tip : Based on common readability standards, aim for 15-20 words per sentence.

For additional insights on sentence length and readability strategies, see Simple sentences (on https://readabilityguidelines.co.uk ) and Popular readability formulas , including the Flesch-Kincaid index, on Wikipedia.

Consistency

Use the same terminology throughout your documentation to ensure a seamless reader experience. For example, if you start referring to "user agents" as browsers, stick with that term consistently. This avoids confusion that can arise from using words interchangeably, even when they share the same meaning.

Additionally, maintain consistent word casing and follow a uniform formatting style throughout your documentation. These practices not only enhance readability but also contribute to a professional presentation of your documentation.

Organize your content for maximum impact

Apply the same principles for organizing your content as you would for organizing your code: spend some time setting a clear goal and thinking about the desired structure for your documentation. Ensure that each subsection contributes to this goal incrementally.

Start with an introduction

In the introduction, first describe the feature you're documenting. Next, set the context by explaining why learning about the feature would be beneficial to the readers. This can include describing real-life scenarios where the feature can be useful. The more relevance you add to the topic, the easier it will be for readers to understand and engage with the content.

Progress logically

The following questions can help you ensure that your content is progressing logically:

  • Is your document structured to guide readers from foundational concepts to more advanced ones? Are there sections to introduce the " what " to establish a base before delving into the " why " and " how "? Consider whether the document structure mirrors the natural learning path for the topic. Aligning the document's structure with the natural progression of learning helps readers build their knowledge step-by-step and also enhances the overall learning experience.
  • Are there sufficient how-to guides or examples following the conceptual sections?
  • Consider the flow of the content. Is it following a logical sequence — from one sentence to the next, from one paragraph to the next, and from one section to the next? Does each section logically build on the information presented previously, avoiding abrupt jumps or gaps in the content?

Additionally, as you work on the draft, always ask yourself:

  • What reader questions am I addressing with this sentence?
  • Can I add a simplistic or real-life use case to explain this concept?

Include examples

Imagine sitting next to someone as you explain the concepts to them. Preempt their questions and address them in your writing. Use this approach to add as many relevant examples as possible.

When adding examples, don't restrict yourself to only code; include non-code scenarios to demonstrate a feature's utility. This helps readers understand the concepts better and also caters to different learning styles. Consider providing real-world scenarios or use cases to illustrate how the feature or concept applies in practical situations.

Optimize the document structure and length

Evaluate your documentation's structure to ensure it maintains a logical and balanced hierarchy.

  • Ensure that each section and subsection has a clear purpose and sufficient content.
  • Look for instances where a main section contains only one subsection (orphan), such as a single H3 section under an H2 section. This indicates that you need to reorganize your content or make some additions.
  • Check if there are lower-level headings such as H4 . Too many subsections can be overwhelming for readers, making it difficult for them to grasp the information. In such cases, consider presenting the content as a bulleted list instead to help readers retain the key points more effectively. This approach helps to simplify the hierarchy and also contributes to easier navigation.
  • While there should be sufficient content for each section, pay attention to the overall length. If any section becomes too extensive, it can be overwhelming for readers. Split large sections into multiple logical subsections or restructure the content into new sections and subsections. Grouping content into digestible pieces helps maintain focus and improve navigation for readers.

Proofread your writing

One aspect that cannot be stressed enough is the importance of self-reviewing and proofreading what you've written. Whether you're creating a large document or a short paragraph, this step is crucial.

Taking the time to fully review your work will help you identify sections that don't flow well or can be improved for clarity. During self-review, aim to spot and remove redundancy (repetition of ideas without adding value) and repetitiveness (overuse of words or phrases). These refinements will ensure your documentation is clear and coherent and conveys your ideas as intended.

Proofread and then take a break before you review again. Only then submit your work. While spell checkers can flag spelling errors, they might not flag incorrect use of words, such as an unintended use of "he" instead of "the". It's best to take a break and return with fresh eyes to catch any errors you might have missed. Pay close attention to identify inconsistencies in tone, style, tense, or formatting and make the necessary adjustments.

Additional tips

To improve the clarity and accessibility of your documentation, also keep the following guidelines and tips in mind. To go in-depth into any of the topics, feel free to consult our Writing style guide .

  • Bulleted vs numbered lists : Lists, in general, make documentation easier to scan. Use bulleted lists when there is no specific order of the items. Use numbered lists when the steps need to be followed in the specific order. Always include a lead-sentence before beginning a list to provide context.
  • Commas : Use a comma after an introductory clause to improve readability and to clarify the sentence structure. Use a comma to separate items in a list to ensure clarity.
  • Alt text : Always provide an alternative text for the images you add to content. This makes your documentation accessible to people using screen readers. In addition to images, ensure that video and audio files have accompanying descriptive texts.
  • Descriptive link text : Make sure each link text is clear even out of context and clearly indicates where the link leads. Descriptive link texts also help people using screen readers understand the destination of links. For example, use "Read our writing style guide to learn more" instead of "Click here to learn more".
  • Inclusive language : Make your documentation welcoming to everyone. Strive to use words that respect and acknowledge the diversity of your audience.

That's it for this article. I hope you found these tips helpful as a quick refresher on technical writing best practices. Remember that learning how to create effective and easy-to-use documentation is an ongoing process. It starts with understanding your audience and the goals of your documentation. By applying these technical writing principles and tips, you'll certainly be able to enhance the clarity and overall quality of your documentation.

Let me know if you learned something new or if there's any idea that resonated with you. I'd also like to hear if there are any best practices you use in your technical documentation workflow. Share with us on Mastodon or Discord .

Previous Post Leveraging Bun on Vultr: A superior Node.js alternative

Stay informed with mdn.

Get the MDN newsletter and never miss an update on the latest web development trends, tips, and best practices.

tech report writing document

Create a form in Word that users can complete or print

In Word, you can create a form that others can fill out and save or print.  To do this, you will start with baseline content in a document, potentially via a form template.  Then you can add content controls for elements such as check boxes, text boxes, date pickers, and drop-down lists. Optionally, these content controls can be linked to database information.  Following are the recommended action steps in sequence.  

Show the Developer tab

In Word, be sure you have the Developer tab displayed in the ribbon.  (See how here:  Show the developer tab .)

Open a template or a blank document on which to base the form

You can start with a template or just start from scratch with a blank document.

Start with a form template

Go to File > New .

In the  Search for online templates  field, type  Forms or the kind of form you want. Then press Enter .

In the displayed results, right-click any item, then select  Create. 

Start with a blank document 

Select Blank document .

Add content to the form

Go to the  Developer  tab Controls section where you can choose controls to add to your document or form. Hover over any icon therein to see what control type it represents. The various control types are described below. You can set properties on a control once it has been inserted.

To delete a content control, right-click it, then select Remove content control  in the pop-up menu. 

Note:  You can print a form that was created via content controls. However, the boxes around the content controls will not print.

Insert a text control

The rich text content control enables users to format text (e.g., bold, italic) and type multiple paragraphs. To limit these capabilities, use the plain text content control . 

Click or tap where you want to insert the control.

Rich text control button

To learn about setting specific properties on these controls, see Set or change properties for content controls .

Insert a picture control

A picture control is most often used for templates, but you can also add a picture control to a form.

Picture control button

Insert a building block control

Use a building block control  when you want users to choose a specific block of text. These are helpful when you need to add different boilerplate text depending on the document's specific purpose. You can create rich text content controls for each version of the boilerplate text, and then use a building block control as the container for the rich text content controls.

building block gallery control

Select Developer and content controls for the building block.

Developer tab showing content controls

Insert a combo box or a drop-down list

In a combo box, users can select from a list of choices that you provide or they can type in their own information. In a drop-down list, users can only select from the list of choices.

combo box button

Select the content control, and then select Properties .

To create a list of choices, select Add under Drop-Down List Properties .

Type a choice in Display Name , such as Yes , No , or Maybe .

Repeat this step until all of the choices are in the drop-down list.

Fill in any other properties that you want.

Note:  If you select the Contents cannot be edited check box, users won’t be able to click a choice.

Insert a date picker

Click or tap where you want to insert the date picker control.

Date picker button

Insert a check box

Click or tap where you want to insert the check box control.

Check box button

Use the legacy form controls

Legacy form controls are for compatibility with older versions of Word and consist of legacy form and Active X controls.

Click or tap where you want to insert a legacy control.

Legacy control button

Select the Legacy Form control or Active X Control that you want to include.

Set or change properties for content controls

Each content control has properties that you can set or change. For example, the Date Picker control offers options for the format you want to use to display the date.

Select the content control that you want to change.

Go to Developer > Properties .

Controls Properties  button

Change the properties that you want.

Add protection to a form

If you want to limit how much others can edit or format a form, use the Restrict Editing command:

Open the form that you want to lock or protect.

Select Developer > Restrict Editing .

Restrict editing button

After selecting restrictions, select Yes, Start Enforcing Protection .

Restrict editing panel

Advanced Tip:

If you want to protect only parts of the document, separate the document into sections and only protect the sections you want.

To do this, choose Select Sections in the Restrict Editing panel. For more info on sections, see Insert a section break .

Sections selector on Resrict sections panel

If the developer tab isn't displayed in the ribbon, see Show the Developer tab .

Open a template or use a blank document

To create a form in Word that others can fill out, start with a template or document and add content controls. Content controls include things like check boxes, text boxes, and drop-down lists. If you’re familiar with databases, these content controls can even be linked to data.

Go to File > New from Template .

New from template option

In Search, type form .

Double-click the template you want to use.

Select File > Save As , and pick a location to save the form.

In Save As , type a file name and then select Save .

Start with a blank document

Go to File > New Document .

New document option

Go to File > Save As .

Go to Developer , and then choose the controls that you want to add to the document or form. To remove a content control, select the control and press Delete. You can set Options on controls once inserted. From Options, you can add entry and exit macros to run when users interact with the controls, as well as list items for combo boxes, .

Adding content controls to your form

In the document, click or tap where you want to add a content control.

On Developer , select Text Box , Check Box , or Combo Box .

Developer tab with content controls

To set specific properties for the control, select Options , and set .

Repeat steps 1 through 3 for each control that you want to add.

Set options

Options let you set common settings, as well as control specific settings. Select a control and then select Options to set up or make changes.

Set common properties.

Select Macro to Run on lets you choose a recorded or custom macro to run on Entry or Exit from the field.

Bookmark Set a unique name or bookmark for each control.

Calculate on exit This forces Word to run or refresh any calculations, such as total price when the user exits the field.

Add Help Text Give hints or instructions for each field.

OK Saves settings and exits the panel.

Cancel Forgets changes and exits the panel.

Set specific properties for a Text box

Type Select form Regular text, Number, Date, Current Date, Current Time, or Calculation.

Default text sets optional instructional text that's displayed in the text box before the user types in the field. Set Text box enabled to allow the user to enter text into the field.

Maximum length sets the length of text that a user can enter. The default is Unlimited .

Text format can set whether text automatically formats to Uppercase , Lowercase , First capital, or Title case .

Text box enabled Lets the user enter text into a field. If there is default text, user text replaces it.

Set specific properties for a Check box .

Default Value Choose between Not checked or checked as default.

Checkbox size Set a size Exactly or Auto to change size as needed.

Check box enabled Lets the user check or clear the text box.

Set specific properties for a Combo box

Drop-down item Type in strings for the list box items. Press + or Enter to add an item to the list.

Items in drop-down list Shows your current list. Select an item and use the up or down arrows to change the order, Press - to remove a selected item.

Drop-down enabled Lets the user open the combo box and make selections.

Protect the form

Go to Developer > Protect Form .

Protect form button on the Developer tab

Note:  To unprotect the form and continue editing, select Protect Form again.

Save and close the form.

Test the form (optional)

If you want, you can test the form before you distribute it.

Protect the form.

Reopen the form, fill it out as the user would, and then save a copy.

Creating fillable forms isn’t available in Word for the web.

You can create the form with the desktop version of Word with the instructions in Create a fillable form .

When you save the document and reopen it in Word for the web, you’ll see the changes you made.

Facebook

Need more help?

Want more options.

Explore subscription benefits, browse training courses, learn how to secure your device, and more.

tech report writing document

Microsoft 365 subscription benefits

tech report writing document

Microsoft 365 training

tech report writing document

Microsoft security

tech report writing document

Accessibility center

Communities help you ask and answer questions, give feedback, and hear from experts with rich knowledge.

tech report writing document

Ask the Microsoft Community

tech report writing document

Microsoft Tech Community

tech report writing document

Windows Insiders

Microsoft 365 Insiders

Was this information helpful?

Thank you for your feedback.

IMAGES

  1. 50 Professional Technical Report Examples (+Format Samples) ᐅ

    tech report writing document

  2. Technical Report Writing

    tech report writing document

  3. 50 Professional Technical Report Examples (+Format Samples) ᐅ

    tech report writing document

  4. 50 Professional Technical Report Examples (+Format Samples) ᐅ

    tech report writing document

  5. 50 Professional Technical Report Examples (+Format Samples) ᐅ

    tech report writing document

  6. Admission Essay: Technical report writing sample

    tech report writing document

VIDEO

  1. WRITING REPORT

  2. #8 Report Writing 1

  3. REPORT WRITING|| HOW TO WRITE REPORT|| REPORT WRITING BY SK JAKHAR

  4. How to write Report writing🤔

  5. report Writing। How to write a report । format। pattern for class 12th

  6. TS Skills (Acrobat): Combine PDFs

COMMENTS

  1. PDF A Guide to Writing Formal Technical Reports

    Microsoft Word - A Guide to Writing Formal Technical Reports.docx 1. About Formal Technical Reports ............................................................................................. 1 1.1 Your Audience ................................................................................................................................... 1

  2. PDF A guide to technical report writing

    What makes a good technical report? Objectives 2.1 Who are you producing the report for? Format 3.1 Appendices 3.2 Sections and subsections 3.3 References Writing 4.1 Spelling 4.2 Punctuation 4.3 Sentences 4.4 Paragraphs 4.5 Formality 4.6 Example Diagrams 5.1 Positioning 5.2 Tables 5.3 Graphs 5.4 Diagram references

  3. Guide to Technical Report Writing

    2 Structure A technical report should contain the following sections; 3 Presentation For technical reports required as part of an assessment, the following presentation guidelines are recommended; 4 Planning the report There are some excellent textbooks contain advice about the writing process and how to begin (see Section 16 ).

  4. Technical Report: What is it & How to Write it? (Steps & Structure

    (Definition) A technical report is described as a written scientific document that conveys information about technical research in an objective and fact-based manner. This technical report consists of the three key features of a research i.e process, progress, and results associated with it.

  5. The Formal Technical Report

    The items listed in this section are often overlooked by those new to technical report writing. However, these items set the stage for how a technical report is received which can impact the author, positively or negatively. ... Using the APA style, the parenthetical citation at the location in the document where the copied or paraphrased ...

  6. Chapter 1: Introduction to Technical and Report Writing

    Visuals & Readability. To make a document more reader friendly, many technical writers rely on visuals to achieve this goal. [5] For example, la bels, callouts and captions are identifying text for graphics. Labels and callouts identify specific elements or features on a graphic; whereas captions are short phrases or sentences that describe the graphic.

  7. PDF A guide to technical report writing

    6. Conclusion. The report is checked, its appearance is pleasing, it is easy to handle, 'interesting' and 'readable', to quote the criteria suggested at the beginning of this Guide. If the technical content is as good as the organisation, writing, illustration and finishing, then the report should delight the reader.

  8. A step-by-step guide to writing a technical report

    A technical report is a document that presents the result of research and analysis in a way that non-experts can understand. If your work requires you to write a technical report at some point in your career, knowing exactly what a technical report is and how to write one means you're able to write an effective and professional report.

  9. How to Write Technical Report

    The process of writing a tech report is the same as writing documentation. Before starting to write a tech report, define your target audience to make your content more relevant to...

  10. How to write technical documentation

    Writing technical documentation is an essential part of any software development workflow. It doesn't just help developers and other stakeholders understand what you built — but also why and how you built it. Here, we'll explore what technical documentation is and why it's important.

  11. Technical Report Writing Guidelines

    About the book This document specifies the recommended format to be used when submitting a formal technical report in a variety of disciplines and purposes. Also, this manual can be used as a guide to compose less formal reports, such as lab reports, that may consist of a subset of the items presented here.

  12. Technical Report Writing-A Comprehensive Guide

    Free Counselling : IN +91 9891953953 US +1 2099044506. Technical report writing is a way of communicating information about a technical or scientific topic in a clear and concise manner. The goal is to convey complex ideas and data to a specific audience, often other professionals or decision-makers, in a format that is easy to understand.

  13. What is Technical Writing Report?

    Jan 16, 2019 -- 1 FAQ on Technical Writing In this article, I will tell you what a technical report is, why companies need it and how to write it. What is a technical report? Technical...

  14. Engineering Technical Reports

    Engineering Technical Reports. Technical reports include various types of "technical" information. For example, if you need to report why a design or piece of equipment failed, you'd write a forensic report. Or, you might have to write about a design you created. Then, you'd produce a design report or, you may need to combine these two.

  15. How to Write a Technical Report (With Benefits and Steps)

    Related: 7 Technical Writing Courses to Help Develop Your Skills. 6. Write a conclusion. The conclusion of the report can summarize your findings, describe their importance, and make recommendations for further research. Try to explain to the reader why your findings are important and indicate potential next steps.

  16. 50 Professional Technical Report Examples (+Format Samples)

    A technical report example is a written document made by a researcher which contains the details about a project's results. After creating the technical report, the researcher submits it to the project's sponsor. Such a report may contain procedures, design criteria, research history, images or illustrations, and other data relevant to the project.

  17. PDF A Guide for the Sciences Merrimack College Writing Center

    What is the process for writing a technical report? The process is largely similar to writing any document, though perhaps more structured. Figure 1 Technical illustrates the process, noting the depth of Report Writing planning and the recursive nature of revision, editing, and Process

  18. Write a Good Technical Report

    A good technical report can have an important effect on a wide range of people. This chapter provides some techniques for preparing, choosing a suitable structure, providing the right amount of information in the right places, and making the points with clarity. It is much less embarrassing and painful for an engineering mistake to be found in print before it appears in fact. Thus, a technical ...

  19. Technical Writing Standards

    When writing technical documents, engineers rely on style manuals, which provide standards for writing and designing documents. Style manuals ensure consistency in writing and formatting documents written for academic or workplace communications. Academic disciplines, including academic journals, have their own style manuals.

  20. What is a Technical Report Document?

    If you're interested in learning more about what a technical report document is, download our syllabus to the technical writing courses we provide on Technic...

  21. Chapter 1: Introduction to Technical and Report Writing

    Technical writing is an audience-centered means of communication that provides a reader with clear and easy access to information. In the business world, time equates to profit, and profit is the force behind all business interaction. The technical writer and reader have a vis-à-vis relationship.

  22. 26 Best Technical Report Examples, Format, and Templates

    A technical report is a document created by a researcher that discusses the project's outcomes and is delivered to the project's sponsor. It is defined as a written technical document that gives accurate and evidence-based information.

  23. Creating effective technical documentation

    To support you in creating effective technical documentation, this article provides an overview of the core principles of technical writing. It also highlights the best practices for creating clear and accessible documentation. Applying these technical writing principles helps us maintain the high quality of content on MDN.

  24. 17 Professional Technical Report Templates (+Format Samples)

    17 Professional Technical Report Templates and Examples (Free Download) Advertisements Business 17 Professional Technical Report Templates (+Format Samples) Preparing a technical report may seem straightforward. A researcher has completed their work on a particular subject and needs to summarize the work for others to review and comment on.

  25. PDF Gemini1.5:Unlockingmultimodal understandingacrossmillionsoftokensof context

    * When transcribing numbers, write the digits, i.e. write 1.7 and not one point seven, and write 100 instead of one hundred etc. * Only output the transcript, exactly as said in the speech segment. * Do not continue the speech segment. * Include everything said in the speech segment. * Use mathematical notation where needed, eg. x ^ 6Y.

  26. Create a form in Word that users can complete or print

    Open a template or use a blank document. To create a form in Word that others can fill out, start with a template or document and add content controls. Content controls include things like check boxes, text boxes, and drop-down lists. If you're familiar with databases, these content controls can even be linked to data.

  27. READ: Special counsel Robert Hur's report on Biden's handling of

    Special counsel Robert Hur released a searing report Thursday that concluded President Joe Biden willfully retained and disclosed classified military and national security information but will not ...

  28. Opinion: Robert Hur's personal and painful jabs at Joe Biden

    A long-awaited report cleared President Joe Biden of any wrongdoing in his mishandling of classified documents February 8, but dropped a political bombshell by painting the Democrat as a "well ...

  29. Takeaways from special counsel's report into Biden's handling of

    The special counsel report found that Biden willfully retained classified information, including top secret documents, and knew he was in possession of some documents as far back as 2017.