how to write a technical assignment

8 Technical Writing Examples to Inspire You

Become a Certified Technical Writer

As a technical writer, you may end up being confused about your job description because each industry and organization can have varying duties for you. At times, they may ask for something you’ve never written before. In that case, you can consider checking out some technical writing examples to get you started.

If you’re beginning your technical writing career, it’s advisable to go over several technical writing examples to make sure you get the hang of it. You don’t necessarily have to take a gander over at industry-specific examples; you can get the general idea in any case.

This article will go over what technical writing is and some of the common technical writing examples to get you started. If you’re looking to see some examples via video, watch below. Otherwise, skip ahead.

If you’re looking to learn via video, watch below. Otherwise, skip ahead.

Let’s start by covering what technical writing is .

What Exactly is Technical Writing?

Technical writing is all about easily digestible content regarding a specialized product or service for the public. Technical writers have to translate complex technical information into useful and easy-to-understand language.

There are many examples of technical writing, such as preparing instruction manuals and writing complete guides. In some cases, technical writing includes preparing research journals, writing support documents, and other technical documentation.

The idea is to help the final user understand any technical aspects of the product or service.

In other cases, technical writing means that the writer needs to know something. For example, pharmaceutical companies may hire medical writers to write their content since they have the required knowledge.

If you’re interested in learning more about these technical writing skills, then check out our Technical Writing Certification Course.

8 Technical Writing Examples to Get You Started

As a technical writer, you may have to learn new things continually, increase your knowledge, and work with new forms of content. While you may not have experience with all forms of technical writing, it’s crucial to understand how to do it.

If you learn all the intricacies of technical writing and technical documents, you can practically work with any form of content, given that you know the format.

Therefore, the following examples of technical writing should be sufficient for you to get an idea. The different types of technical writing have unique characteristics that you can easily learn and master effectively.

1. User Manuals

User manuals or instruction manuals come with various products, such as consumer electronics like televisions, consoles, cellphones, kitchen appliances, and more. The user manual serves as a complete guide on how to use the product, maintain it, clean it, and more. All technical manuals, including user manuals, have to be highly user-friendly. The technical writer has to write a manual to even someone with zero experience can use the product. Therefore, the target audience of user manuals is complete novices, amateurs, and people using the product/s for the first time.

Traditionally, user manuals have had text and diagrams to help users understand. However, user manuals have photographs, numbered diagrams, disclaimers, flow charts, sequenced instructions, warranty information, troubleshooting guides, and contact information in recent times.

Technical writers have to work with engineers, programmers, and product designers to ensure they don’t miss anything. The writer also anticipates potential issues ordinary users may have by first using the product. That helps them develop a first-hand experience and, ultimately, develop better user manuals.

The point of the user manual isn’t to predict every possible issue or problem. Most issues are unpredictable and are better handled by the customer support or help desk. User manuals are there to address direct and common issues at most.

You can check out some user manual examples and templates here . You can download them in PDF and edit them to develop an idea about how you can write a custom user manual for your product.

2. Standard Operating Procedures (SOP)

Standard operating procedures are complete processes for each organization’s various tasks to ensure smoother operations. SOPs help make each process more efficient, time-saving, and less costly.

An SOP document can include:

Everything from the method of processing payroll.
Hiring employees.
Calculating vacation time to manufacturing guidelines.

In any case, SOPs ensure that each person in an organization works in unison and uniformly to maintain quality.

SOPs help eliminate irregularities, favoritism, and other human errors if used correctly. Lastly, SOPs make sure employees can take the responsibilities of an absent employee, so there’s no lag in work.

Therefore, developing SOPs requires a complete study of how an organization works and its processes.

Here are some examples of standard operating procedures you can study. You can edit the samples directly or develop your own while taking inspiration from them.

3. Case Studies & White Papers

Case studies and white papers are a way of demonstrating one’s expertise in an area. Case studies delve into a specific instance or project and have takeaways proving or disproving something. White papers delve into addressing any industry-specific challenge, issue, or problem.

Both case studies and white papers are used to get more business and leads by organizations.

Technical writers who write white papers and case studies need to be experts in the industry and the project itself. It’s best if the technical writer has prior experience in writing such white papers.

The writing style of white papers and case studies is unique, along with the formatting. Both documents are written for a specific target audience and require technical writing skills. Case studies are written in a passive voice, while white papers are written in an active voice. In any case, it’s crucial to maintain a certain level of knowledge to be able to pull it off.

You can check out multiple white paper examples here , along with various templates and guides. You can check out some examples here for case studies, along with complete templates.

4. API Documentation

API documentation includes instructions on effectively using and integrating with any API, such as web-API, software API, and SCPIs. API documentation contains details about classes, functions, arguments, and other information required to work with the API. It also includes examples and tutorials to help make integration easier.

In any case, API documentation helps clients understand how it works and how they can effectively implement API. In short, it helps businesses and people interact with the code more easily.

You can find a great example of proper API documentation in how Dropbox’s API documentation works. You can learn more about it here .

5. Press Releases

Press releases are formal documents issued by an organization or agency to share news or to make an announcement. The idea is to set a precedent for releasing any key piece of information in a follow-up press conference, news release, or on a social media channel.

The press release emphasizes why the information is important to the general public and customers. It’s a fact-based document and includes multiple direct quotes from major company stakeholders, such as the CEO.

Usually, press releases have a very specific writing process. Depending on the feasibility, they may have an executive summary or follow the universal press release format.

You can find several examples of press releases from major companies like Microsoft and Nestle here , along with some writing tips.

6. Company Documents

Company documents can include various internal documents and orientation manuals for new employees. These documents can contain different information depending on their use.

For example, orientation manuals include:

The company’s history.
Organizational chart.
List of services and products.
Map of the facility.
Dress codes.

It may also include employee rights, responsibilities, operation hours, rules, regulations, disciplinary processes, job descriptions, internal policies, safety procedures, educational opportunities, common forms, and more.

Writing company documents requires good technical writing skills and organizational knowledge. Such help files assist new employees in settling into the company and integrating more efficiently.

Here are some great examples of orientation manuals you can check out.

7. Annual Reports

Annual reports are yearly updates on a company’s performance and other financial information. Annual reports directly correspond with company stakeholders and serve as a transparency tool.

The annual reports can also be technical reports in some cases. However, mostly they include stock performance, financial information, new product information, and key developments.

Technical writers who develop annual reports must compile all the necessary information and present it in an attractive form. It’s crucial to use creative writing and excellent communication skills to ensure that the maximum amount of information appears clearly and completely.

If the company is technical, such as a robotics company, the technical writer needs to develop a technical communication method that’s easy to digest.

You can check out some annual report examples and templates here .

8. Business Plans

Every company starts with a complete business plan to develop a vision and secure funding. If a company is launching a new branch, it still needs to start with a business plan.

In any case, the business plan has a few predetermined sections. To develop the ideal business plan, include the following sections in it.

Executive Summary – includes the business concept, product, or service, along with the target market. It may also include information on key personnel, legal entity, founding date, location, and brief financial information.
Product or Service Description – includes what the offering is, what value it provides, and what stage of development it is in currently.
Team Members – includes all the information on the management team.
Competitor and Market Analysis – includes a detailed analysis of the target market and potential competitors.
Organizational System – includes information on how the organizational structure would work.
Schedules – include start dates, hiring dates, planning dates, and milestones.
Risks and Opportunities – include profit and loss predictions and projections.
Financial Planning – includes planned income statements, liquidity measures, projected balance sheet, and more.
Appendix – includes the organizational chart, resumes, patents, and more.

The technical writer needs to work closely with the company stakeholders to develop a complete business plan.

According to your industry, you can check out hundreds of business plan samples and examples here .

Becoming an Expert Technical Writer

Becoming an expert technical writer is all about focusing on your strengths. For example, you should try to focus on one to two industries or a specific form of technical writing. You can do various writing assignments and check out technical writing samples to understand what you’re good with.

You can also check out user guides and get online help in determining your industry. Once you’ve nailed down an industry and technical writing type, you can start to focus on becoming an expert in it.

In any case, it always helps to check out technical writing examples before starting any project. Try to check out examples of the same industry and from a similar company. Start your writing process once you have a complete idea of what you need to do.

Since technical writing involves dealing with complex information, the writer needs to have a solid base on the topic. That may require past experience, direct technical knowledge, or an ability to understand multiple pieces of information quickly and effectively.

In becoming a technical writer, you may have to work with various other people, such as software developers, software engineers, human resources professionals, product designers, and other subject matter experts.

While most organizations tend to hire writers with a history in their fields, others opt for individuals with great writing skills and team them up with their employees.

Technical writers may also work with customer service experts, product liability specialists, and user experience professionals to improve the end-user experience. In any case, they work closely with people to develop digestible content for the end customers.

Today, you can also find several technical writers online. There is an increasing demand for technical writing because of the insurgence of SaaS companies, e-commerce stores, and more.

In the end, technical writers need to have a strong grasp of proper grammar, terminology, the product, and images, graphics, sounds, or videos to explain documentation.

If you are new to technical writing and are looking to break-in, we recommend taking our Technical Writing Certification Course , where you will learn the fundamentals of being a technical writer, how to dominate technical writer interviews, and how to stand out as a technical writing candidate.

We offer a wide variety of programs and courses built on adaptive curriculum and led by leading industry experts.

Work on projects in a collaborative setting
Take advantage of our flexible plans and community
Get access to experts, templates, and exclusive events

Become a Certified Technical Writer. Professionals finish the training with a full understanding of how to guide technical writer projects using documentation foundations, how to lead writing teams, and more.

Become a Certified UX Writer. You'll learn how to excel on the job with writing microcopy, content design, and creating conversation chatbots.

Become a Certified Grant Writer. In this course, we teach the fundamentals of grant writing, how to create great grant proposals, and how to stand out in the recruiting process to land grant writing jobs.

Please check your email for a confirmation message shortly.

Join 5000+ Technical Writers

Get our #1 industry rated weekly technical writing reads newsletter.

Your syllabus has been sent to your email

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

Understanding Assignment Expectations

Dawn Atkinson

Chapter Overview

To craft a well-written technical document, you must first understand expectations for the piece in terms of purpose, audience, genre, writing style, content, design, referencing style, and so forth. This same truth applies to an academic assignment: you will be able to proceed with your writing task in a more straightforward way if you dedicate some time to understanding what the assignment asks before you begin to plan and write it. This chapter aims to help you deconstruct writing assignment prompts—in other words, carefully consider them by looking closely at their component parts—and use specifications, feedback, and rubrics to meet assignment requirements. Using the definition provided by Carnegie Mellon University’s Eberly Center for Teaching Excellence and Educational Innovation (2019, para. 1), a rubric specifies how levels of skillfulness on an assignment relate to grading criteria and, thus, to performance standards.

What does the assignment ask you to do?

College professors oftentimes provide students with directions or prompts that outline requirements for assignments. Read these instructions thoroughly when you first receive them so that you have time to clear up any uncertainties before the assignment is due. While reading, look for words that will help you focus on the task at hand and define its scope; many assignment instructions use key words or phrases, such as those presented in the following list, which is adapted from Learn Higher (2015, “Key Words in the Title”), to establish expectations.

The words and phrases listed indicate the purpose for an assignment and communicate what it should contain (its content). Use the list to clarify your task for the assignment; however, if you are still not sure what the assignment asks you to do after identifying its key words and phrases and defining their meanings, arrange an appointment with your instructor to discuss your questions. Think of your instructor as a vital resource who can help to clarify your uncertainties and support your academic success.

What are the assignment specifications?

In addition to looking for key words and phrases in your assignment directions, also pay attention to other specifics that communicate expectations. The following list, adapted from Learn Higher (2019, “Be Practical”), identifies such specifics.

When is the assignment due?
Do you need to submit a draft before you submit the final copy for grading? If so, when is the draft due?
Are you required to submit a paper copy of the assignment, an electronic copy, or both?
What is the word limit?
Are you required to use sources? If so, what kind and how many?
What referencing style are you required to use?
Who is the audience for the assignment?
What design requirements do you need to follow?
Does the assignment specify that you should use a certain document type (a genre)?

Although the directions for your assignment may not provide specific directions about writing style, you can likely determine the level of formality expected in the document by identifying its genre. For example, essays, letters, and reports tend to use formal language to communicate confidently and respectfully with readers, whereas emails and social media posts may use less formal language since they offer quick modes of interaction.

What does past assignment feedback indicate about the instructor’s priorities?

If you have received feedback on past papers, look through the comments carefully to determine what the instructor considers important in terms of assignment preparation and grading. You may notice similar comments on multiple assignments, and these themes can point to things you have done well—and should thus aim to demonstrate in future assignments—and common areas for improvement. While reviewing the feedback, make a note of these themes so you can consult your notes when preparing upcoming assignments.

To avoid feeling overwhelmed by feedback, you might also prioritize the themes you intend to address in your next writing assignment by using a template, such as that provided in Figure 1, when making notes. If you have questions about past feedback comments when making notes, seek help before preparing your upcoming assignment.

What positive aspects of your past assignments do you want to demonstrate in your next assignment?

Punctuation (area for improvement): Which three punctuation issues do you intend to address when writing your next assignment? Record your responses below. In addition, locate pages in your textbook that will help you address these issues, and record the pages below.

Sentence construction (area for improvement): Which three sentence construction issues do you intend to address when writing your next assignment? Record your responses below. In addition, locate pages in your textbook that will help you address these issues, and record the pages below.

Citations and references (area for improvement): Which three citation and referencing issues do you intend to address when writing your next assignment? Record your responses below. In addition, locate pages in your textbook that will help you address these issues, and record the pages below.

Figure 1. Template for prioritizing feedback comments on past assignments

Most college writing instructors spend considerable time providing feedback on assignments and expect that students will use the feedback to improve future work. Show your instructor that you respect his or her effort, are invested in your course, and are taking responsibility for your own academic success by using past feedback to improve future assignment outcomes.

What assessment criteria apply to the assignment?

If your instructor uses a rubric to identify the grading criteria for an assignment and makes the rubric available to students, this resource can also help you understand assignment expectations. Although rubrics vary in format and content, in general they outline details about what an instructor is looking for in an assignment; thus, you can use a rubric as a checklist to ensure you have addressed assignment requirements.

Table 1 presents a sample rubric for a writing assignment. Notice that performance descriptions and ratings are identified in the horizontal cells of the table and grading criteria are listed in the vertical cells on the left side of the table.

Table 1. A sample writing assignment rubric

Although the rubrics you encounter may not look exactly like Table 1, the language used in a rubric can provide insight into what an instructor considers important in an assignment. In particular, pay attention to any grading criteria identified in the rubric, and consult these criteria when planning, editing, and revising your assignment so that your work aligns with the instructor’s priorities.

What can you determine about assignment expectations by reading an assignment sheet?

Spend a few minutes reviewing the example assignment sheet that follows, or review an assignment sheet that your instructor has distributed. Use the bullet list under the heading “What are the assignment specifications? ” to identify the specifics for the assignment.

Book Selection Email

Later this semester, you will be asked to produce a book review. To complete the assignment, you must select and read a non-fiction book about a science topic written for the general public. The current assignment requires you to communicate your book selection in an email message that follows standard workplace conventions.

Content Requirements

Address the following content points in your email message.

Identify the book you intend to read and review.
Tell the reader why you are interested in the book. For example, does it relate to your major? If so, how? Does it address an area that has not been widely discussed in other literature or in the news? Does it offer a new viewpoint on research that has already been widely publicized?
Conclude by offering to supply additional information or answer the reader’s questions.

You will need to conduct some initial research to address the above points.

Formatting Requirements

Follow these guidelines when composing your email message.

Provide an informative subject line that indicates the purpose for the communication.
Choose an appropriate greeting, and end with a complimentary closing.
Create a readable message by using standard capitalization and punctuation, skipping lines between paragraphs, and avoiding fancy typefaces and awkward font shifts.
Use APA style when citing and referencing outside sources in your message.

Your instructor will read your email message. Please use formal language and a respectful tone when communicating with a professional.

Grading Category

This assignment is worth 10 points and will figure into your daily work/participation grade.

Submission Specifications and Due Date

Send your email to your instructor by noon on _______.

How will you respond to a case study about understanding assignment expectations?

We will now explore a case study that focuses on the importance of understanding assignment expectations. In pairs or small groups, examine the case and complete the following tasks:

Identify what the student argues in his email and the reasoning and evidence he uses to support his argument.
Discuss whether you agree with the student’s argument, and supply explanations for your answers.
Identify possible solutions or strategies that would have prevented the problems discussed in the case study and the benefits that would have been derived from implementing the solutions.
Present your group’s findings in a brief, informal presentation to the class.

Casey: The Promising Student Who Deflected Responsibility

Casey, a student with an impressive high school transcript, enrolled in an introduction to technical writing course his first semester in college. On the first day of class, the instructor discussed course specifics stated on the syllabus, and Casey noticed that she emphasized the following breakdown of how assignments, daily work/participation, and quiz grades would contribute to the students’ overall grades.

Instructions Assignment 10%

Report Assignment 15%

Critical Review Assignment 15%

Researched Argument Assignment 20%

Performance Evaluation Assignment 15%

Daily Work/Participation 10%

Quizzes 15%

Casey also noticed that the instructor had an attendance policy on the syllabus, so he decided that he should attend class regularly to abide by this policy.

During the semester, the instructor distributed directions for completing the five major course assignments listed above; these sheets provided details about the purpose, audience, genre, writing style, content, design, and referencing format for the assignments. Casey dutifully read through each assignment sheet when he received it and then filed it in his notebook. Although he completed all his course assignments on time, he did not earn grades that he considered acceptable in comparison to the high marks he received on his papers in high school.

When Casey did not receive the final grade he thought he deserved in his introduction to technical writing class, he sent his instructor an email that included the following text.

I am writing to you about why I deserve an A for my writing class. In my opinion, the requirements for an A should be attendance, on-time submission of assignments, and active participation in class activities.

Attendance is the most important factor in obtaining an A . Being in class helps with understanding course content—students can ask for clarification during class when they have doubts about topics covered in class. I think I deserve an A because I attended 27 out of 28 total class meetings during the semester.

On-time submission of assignments is another aspect that I feel I should be graded on. During the semester, I turned in all my assignments well before deadlines.

The third aspect that I think should be used in determination of my grade is active participation for all in-class activities. My consistent attendance in class indicates that I actively participated in all activities during class time.

After reviewing all the aspects I think are the prerequisites for an A , I feel that I deserve an A for my writing class.

After his instructor replied to the email by suggesting that Casey review the syllabus for further information about how his final grade was calculated, he complained bitterly to his friends about the instructor.

The university that Casey attended required students to complete end-of-course evaluations at the end of each semester. Upon receiving his final course grade in introduction to technical writing, he gave the instructor a poor review on the evaluation. In the review, he indicated that he oftentimes did not understand assignment requirements and was not sure who to turn to for help.

How will you demonstrate adherence to APA conventions?

To understand how to construct APA in-text citations and references in accordance with established conventions, review the following online modules.

“APA Refresher: In-Text Citations 7th Edition” (Excelsior Online Writing Lab, 2020a) at https://owl.excelsior.edu/writing-refresher/apa-refresher/in-text-citations/
“APA Refresher: References 7th Edition” (Excelsior Online Writing Lab, 2020b) at https://owl.excelsior.edu/writing-refresher/apa-refresher/references/

How will you relate the case study to points made in the rest of the chapter and in an essay?

Read an essay entitled “So You’ve Got a Writing Assignment. Now What?” (Hinton, 2010) at https://wac.colostate.edu/docs/books/writingspaces1/hinton–so-youve-got-a-writing-assignment.pdf ; this essay expands upon a number of ideas raised in the current textbook chapter. Afterwards, write a response memo for homework. Address the items listed below in your memo, and cite and reference any outside sources of information that you use.

Explain how the case study presented in this chapter relates to points made elsewhere in the chapter and in the essay in terms of understanding assignment expectations.
Explain how this chapter, the case study, and the essay are relevant and useful to your own work in college. Do the texts offer new ways to approach writing assignments? Do they call into question unhelpful beliefs you hold about your own success in writing courses or in college? Do they offer solutions to problems you have encountered in college classes? How might you combine the points made in the texts with helpful practices you already demonstrate?

Consult the “Writing Print Correspondence” chapter of this textbook for guidance when writing and formatting your memo.

Remember to edit, revise, and proofread your document before submitting it to your instructor. The following multipage handout, produced by the Writing and Communication Centre, University of Waterloo (n.d.), may help with these efforts.

https://uwaterloo.ca/writing-and-communication-centre/sites/ca.writing-and-communication-centre/files/uploads/files/active_and_passive_voice_0.pdf

Active / Passive Voice

Strong, precise verbs are fundamental to clear and engaging academic writing. However, there is a rhetorical choice to be made about whether you are going to highlight the subject that performs the action or the action itself. In active voice , the subject of the sentence performs the action. In passive voice , the subject of the sentence receives the action. Recognizing the differences between active and passive voice, including when each is generally used, is a part of ensuring that your writing meets disciplinary conventions and audience expectations.

Helpful Tip: traditionally, writers in STEM fields have used passive voice because the performer of an action in a scientific document is usually less important than the action itself. In contrast, arts and humanities programs have stressed the importance of active voice. However, these guidelines are fluid, and STEM writers are increasingly using active voice in their writing. When in doubt, consult academic publications in your field and talk to your instructor – doing these things should give you a good sense of what’s expected.

Active voice explained

Active voice emphasizes the performer of the action, and the performer holds the subject position in the sentence. Generally, you should choose active voice unless you have a specific reason to choose passive voice (see below for those instances).

e.g., Participants completed the survey and returned it to the reader.

In the above sentence, the performer of the action (participants) comes before the action itself (completed).

Passive voice explained

Passive voice emphasized the receiver of the action, and the subject of the sentence receives the action. When using passive voice, the performer of the action may or may not be identified later in the sentence.

e.g. The survey was completed. In the above sentence, the people who performed the action (those who completed the survey) are not mentioned.

Helpful Tip: One popular trick for detecting whether or not your sentence is in passive voice is to add the phrase by zombies after the verb in your sentence; if it makes grammatical sense, your sentence is passive. If not, your sentence is active. Passive: The trip was taken [by zombies]. Active: Mandy taught the class [by zombies].

When to choose passive voice

Deciding whether or not you should use passive voice depends on a number of factors, including disciplinary conventions, the preferences of your instructor or supervisor, and whether the performer of the action or the action itself is more important. Here are some general guidelines to help you determine when passive voice is appropriate:

The performer is unknown or irrelevant e.g., The first edition of Freud’s The Interpretation of Dreams was published in 1900.
The performer is less important than the action e.g., The honey bees were kept in a humidified chamber at room temperature overnight.

The first sentence in the above quotation is active voice (where the performers want to be highlighted).

Helpful Tip: rhetorical choices often have an ethical dimension. For instance, passive voice may be used by people, organizations, or governments to obscure information or avoid taking direct responsibility. If someone says “the money was not invested soundly,” the decision to not identify the performer of the action (“the accountant did not invest the money soundly”) may be a deliberate one. For this reason, it is crucial that we question the choices we make in writing to ensure that our choices results in correct, clear, and appropriate messaging.

Converting passive voice to active voice

If you are proofreading in order to convert passive voice to active voice in your writing, it is helpful to remember that

Active = performer of action + action
Passive = action itself (may or may not identify the performer afterwards)

Here are some sample revisions:

Passive: It is argued that… Active: Smith argues that…
Passive: A number of results were shown… Active: These results show…
Passive : Heart disease is considered the leading cause of death in North America. Active: Research points to heart disease as the leading cause of death in North America.

Eberly Center, Teaching Excellence & Educational Innovation, Carnegie Mellon University. (2019). Grading and performance rubrics . https://www.cmu.edu/teaching/designteach/teach/rubrics.html

Excelsior Online Writing Lab. (2020a). APA Refresher: In-Text Citations 7th Edition [PowerPoint slides]. License: CC-BY 4.0 . https://owl.excelsior.edu/writing-refresher/apa-refresher/in-text-citations/

Excelsior Online Writing Lab. (2020b). APA Refresher: References 7th Edition [PowerPoint slides]. License: CC-BY 4.0 . https://owl.excelsior.edu/writing-refresher/apa-refresher/references/

Hinton, C.E. (2010). So you’ve got a writing assignment. Now what? In C. Lowe, & P. Zemliansky (Eds.), Writing spaces: Readings on writing (Vol. 1, pp. 18-32). Parlor Press. License: License: CC-BY-NC-SA-3.0 . https://wac.colostate.edu/docs/books/writingspaces1/hinton–so-youve-got-a-writing-assignment.pdf

Learn Higher. (2015). Instruction words in essay questions . License: CC-BY-SA 3.0 . http://www.learnhigher.ac.uk/learning-at-university/assessment/instruction-words-in-essay-questions/

Learn Higher. (2019). Assessment: Step-by-step . License: CC-BY-SA 3.0 . http://www.learnhigher.ac.uk/learning-at-university/assessment/assessment-step-by-step/

Writing and Communication Centre, University of Waterloo. (n.d.). Active and passive voice . License: CC-BY-SA 4.0 . https://uwaterloo.ca/writing-and-communication-centre/sites/ca.writing-and-communication-centre/files/uploads/files/active_and_passive_voice_0.pdf

Share This Book

Technical Writing 101: What is it and How to Get Started

Technical writing is a specialized form of written communication that aims to make complex concepts understandable and accessible to a specific audience. As a freelancer, understanding and mastering this skill can significantly widen your career prospects. In this post, we’ll explore what technical writing is, why it’s important, and how you can get started. The world of technical writing can seem daunting at first, but with the right guidance and resources, anyone can learn how to effectively communicate complex information in a clear, concise manner.

Unpacking the Concept of Technical Writing

So, what exactly is technical writing? At its core, technical writing is a type of communication that uses language to convey technical or specialized topics in a way that is easy to understand. Think of it as the bridge between complex information and the people who need to understand that information. It’s all about breaking down complex concepts and presenting them in a way that is accessible to a specific audience.

One of the key characteristics of technical writing is its focus on clarity and accuracy. Technical writing is not about showcasing your vocabulary or using flowery language. Instead, it’s about getting straight to the point and providing accurate, useful information. This makes it different from other types of writing, such as creative writing or journalism, which may prioritize storytelling or persuasion.

Technical writing can take many forms, including user manuals, how-to guides, technical reports, white papers, and more. The goal is always the same: to make complex information understandable and usable.

Importance of Technical Writing in Today’s Digital Age

In our increasingly digital world, technical writing has become more important than ever. As technology continues to evolve and become more complex, the need for clear, understandable documentation and guides has increased. Whether it’s a user manual for a new piece of software, a technical report on a scientific study, or a guide to using a new piece of machinery, technical writing plays a crucial role in our society.

Technical writing is particularly important in sectors such as IT, healthcare, and manufacturing. In these industries, where complex machinery or software is common, the need for clear, concise instructions and documentation is paramount. A well-written user manual or guide can make the difference between a product being used correctly and efficiently, or not at all.

Moreover, in today’s digital age, businesses are increasingly relying on technical writers to help communicate their products and services to customers. Whether it’s through online help guides, product descriptions, or instructional videos, technical writers play a key role in helping businesses connect with their customers.

Skills Required for Effective Technical Writing

Technical writing is not just about understanding complex concepts and simplifying them for the audience. It also requires a unique set of skills that differentiate technical writers from other types of writers. In this section, we will discuss the essential skills that you need to develop to become an effective technical writer.

Written Communication Skills

At the core of technical writing is the ability to communicate effectively through written words. But what does this mean in practice? Let’s break it down.

Impeccable grammar: Technical writing is all about precision and clarity. Therefore, having a solid grasp of grammar is paramount. Errors in grammar can lead to confusion and misinterpretation, which is a big no-no in technical writing.

Good sentence structure: It’s not just what you say, but how you say it. A well-structured sentence can convey a complex idea simply and effectively. On the other hand, a poorly constructed sentence can make even a simple concept seem complicated.

Rich vocabulary: A good technical writer has a wide vocabulary at their disposal. This allows them to choose the most precise words to express their ideas, enhancing the clarity and effectiveness of their writing.

Are you confident in your grammar, sentence structure, and vocabulary? If not, don’t worry. These are skills that can be improved with consistent practice and learning.

Understanding of Technical Concepts

As a technical writer, you’ll often be tasked with explaining complex technical concepts to a non-technical audience. This requires a deep understanding of these concepts. But why is this so important?

Firstly, it allows you to break down complex information into simple, digestible chunks. Secondly, it gives you the ability to translate technical jargon into everyday language that your audience can understand. Lastly, it enables you to anticipate potential questions or confusion from your audience and address them proactively in your writing.

Understanding technical concepts doesn’t mean you need to be an expert in every field. Instead, it’s about having the curiosity and willingness to learn about new technologies and concepts, and the ability to understand them at a level that allows you to explain them simply and accurately.

Tools Used by Technical Writers

Technical writing is not just about the skills of the writer. It also involves the use of specific tools that help create, manage, and deliver technical information. Let’s take a look at some of the most commonly used tools in technical writing.

Microsoft Word: This is a staple in the toolkit of most writers, not just technical writers. It offers a wide range of features for creating and formatting documents, making it a versatile tool for many writing tasks.

Google Docs: This is a popular choice for collaborative writing projects. It allows multiple writers to work on a document simultaneously, making it easier to share ideas and make changes in real-time.

Diagramming tools: Diagrams are a common feature in technical documents, used to illustrate processes, systems, and relationships between concepts. Tools like Microsoft Visio, Lucidchart, and Draw.io can help you create clear and effective diagrams.

These are just a few examples of the tools used by technical writers. Depending on your specific needs and the nature of your work, you may also use other specialized software for tasks such as project management, version control, and document design.

Steps to Becoming a Technical Writer

Technical writing can seem intimidating at first, but it’s a skill that can be learned and honed over time. If you’re looking to transition into a career in technical writing, here’s a step-by-step guide to get you started:

1. Get a Degree: Although it’s not always required, having a degree in English, Journalism, Communications, or a related field can give you a leg up. Some technical writers also have degrees in fields like Engineering or Computer Science.

2. Gain Technical Knowledge: Depending on the industry you want to write for, you might need to learn specific technical skills or knowledge. For example, if you’re writing for a software company, you’ll need to understand how the software works.

3. Build Your Portfolio: Start creating samples of your technical writing. This could be anything from instruction manuals to how-to guides. A strong portfolio can show potential employers your writing ability and understanding of technical concepts.

4. Gain Experience: Look for internships or entry-level jobs that involve technical writing. This will help you gain practical experience and make valuable connections in the industry.

5. Keep Learning: The field of technical writing is always evolving. Stay updated with the latest trends and tools in the industry.

Tips for Improving Your Technical Writing Skills

Once you’ve made the decision to become a technical writer, you’ll want to continuously improve your skills. Here are some practical tips and strategies for enhancing your technical writing skills:

Practice Makes Perfect: The more you write, the better you’ll get. Practice writing about different topics and in different formats.
Get Feedback: Don’t be afraid to have others review your work. Constructive criticism can help you identify areas for improvement.
Stay Organized: Good technical writing is clear and easy to follow. Make sure your writing is well-structured and logical.
Keep It Simple: Remember, the goal of technical writing is to make complex information easy to understand. Avoid jargon and keep your language simple and direct.
Keep Learning: Stay updated with the latest trends in the industry. This can help you stay relevant and improve your writing.

The Role of a Technical Writer in Project Management

In the realm of project management, the role of a technical writer is often underestimated. They are the silent heroes, diligently working behind the scenes to ensure smooth and effective communication within the team and with clients. Their contributions range from documenting project requirements to creating user manuals.

Firstly, technical writers play a crucial role in documenting project requirements . They work closely with project managers and stakeholders to understand and articulate the project’s objectives, specifications, and deliverables. This documentation serves as the backbone of the project, providing a clear roadmap for the team and ensuring everyone is on the same page.

Secondly, technical writers are responsible for creating user manuals and guides . These documents are essential for guiding end-users in navigating and utilizing the product or service. A well-written user manual can significantly enhance the user experience and contribute to the product’s success.

A table showing the tasks of a technical writer in project management.

Future Trends in Technical Writing

As we look to the future, several trends are set to shape the field of technical writing. These trends are largely driven by advancements in technology, particularly Artificial Intelligence (AI) and machine learning.

One key trend is the rise of AI and machine learning in technical writing. These technologies are being used to automate routine tasks and improve the efficiency of technical writers. For example, AI can assist in generating content, proofreading, and even translating documents into different languages.

Another trend is the growing demand for interactive and multimedia content . As users increasingly expect engaging and interactive experiences, technical writers will need to adapt by incorporating elements such as videos, graphics, and interactive diagrams into their work.

A list of future trends in technical writing.

AI and Machine Learning: Automating routine tasks and improving efficiency.
Interactive and Multimedia Content: Incorporating engaging elements such as videos and interactive diagrams.
Mobile-First Writing: Prioritizing mobile users by creating content that is easily readable on small screens.
Personalized User Assistance: Using data to deliver personalized content and help to users.
Localization: Adapting content to suit different cultures, languages, and regions.

Fiverr Level 1 vs Fiverr Level 2 – What’s The Difference?
How to Get Started in Voice Acting
How Much Does Fiverr Charge Sellers?
What to Include in an Email Signature
Starting a Freelance Writing Career with No Experience

Get Organized & Win More Clients

Kosmo has everything you need to run your freelancing business.

Technical Writing for Beginners – An A-Z Guide to Tech Blogging Basics

If you love writing and technology, technical writing could be a suitable career for you. It's also something else you can do if you love tech but don’t really fancy coding all day long.

Technical writing might also be for you if you love learning by teaching others, contributing to open source projects and teaching others how to do so, too, or basically enjoy explaining complex concepts in simple ways through your writing.

Let's dive into the fundamentals and learn about what you should know and consider when getting started with technical writing.

In this article, we’ll be looking at:

What Technical writing is

Benefits of Technical Writing

Necessary skills to have as a Technical Writer

The Technical Writing Process

Platforms for publishing your articles

Technical Writing Courses

Technical Writing forums and communities
Some amazing technical writers to follow
Final Words and references

What is Technical Writing?

Technical writing is the art of providing detail-oriented instruction to help users understand a specific skill or product.

And a technical writer is someone who writes these instructions, otherwise known as technical documentation or tutorials. This could include user manuals, online support articles, or internal docs for coders/API developers.

A technical writer communicates in a way that presents technical information so that the reader can use that information for an intended purpose.

Technical writers are lifelong learners. Since the job involves communicating complex concepts in simple and straightforward terms, you must be well-versed in the field you're writing about. Or be willing to learn about it.

This is great, because with each new technical document you research and write, you will become an expert on that subject.

Technical writing also gives you a better sense of user empathy. It helps you pay more attention to what the readers or users of a product feel rather than what you think.

You can also make money as a technical writer by contributing to organizations. Here are some organizations that pay you to write for them , like Smashing Magazine , AuthO , Twilio , and Stack Overflow .

In addition to all this, you can contribute to Open Source communities and participate in paid open source programs like Google Season of Docs and Outreachy .

You can also take up technical writing as a full time profession – lots of companies need someone with those skills.

Necessary Skills to Have as a Technical Writer

Understand the use of proper english.

Before you consider writing, it is necessary to have a good grasp of English, its tenses, spellings and basic grammar. Your readers don't want to read an article riddled with incorrect grammar and poor word choices.

Know how to explain things clearly and simply

Knowing how to implement a feature doesn't necessarily mean you can clearly communicate the process to others.

In order to be a good teacher, you have to be empathetic, with the ability to teach or describe terms in ways suitable for your intended audience.

If you can't explain it to a six year old, you don't understand it yourself. Albert Einstein

Possess some writing skills‌‌

I believe that writers are made, not born. And you can only learn how to write by actually writing.

You might never know you have it in you to write until you put pen to paper. And there's only one way to know if you have some writing skills, and that's by writing.

So I encourage you to start writing today. You can choose to start with any of the platforms I listed in this section to stretch your writing muscles.

And of course, it is also a huge benefit to have some experience in a technical field.

Analyze and Understand who your Readers are

The biggest factor to consider when you're writing a technical article is your intended/expected audience. It should always be at the forefront of your mind.

A good technical writer writes based on the reader’s context. As an example , let's say you're writing an article targeted at beginners. It is important not to assume that they already know certain concepts.

You can start out your article by outlining any necessary prerequisites. This will make sure that your readers have (or can acquire) the knowledge they need before diving right into your article.

You can also include links to useful resources so your readers can get the information they need with just a click.

In order to know for whom you are writing, you have to gather as much information as possible about who will use the document.

It is important to know if your audience has expertise in the field, if the topic is totally new to them, or if they fall somewhere in between.

Your readers will also have their own expectations and needs. You must determine what the reader is looking for when they begin to read the document and what they'll get out of it.

To understand your reader, ask yourself the following questions before you start writing:

Who are my readers?
What do they need?
Where will they be reading?
When will they be reading?
Why will they be reading?
How will they be reading?

These questions also help you think about your reader's experience while reading your writing, which we'll talk about more now.

Think About User Experience

User experience is just as important in a technical document as it is anywhere on the web.

Now that you know your audience and their needs, keep in mind how the document itself services their needs. It’s so easy to ignore how the reader will actually use the document.

As you write, continuously step back and view the document as if you're the reader. Ask yourself: Is it accessible? How will your readers be using it? When will they be using it? Is it easy to navigate?

The goal is to write a document that is both useful to and useable by your readers.

Plan Your Document

Bearing in mind who your users are, you can then conceptualize and plan out your document.

This process includes a number of steps, which we'll go over now.

Conduct thorough research about the topic

While planning out your document, you have to research the topic you're writing about. There are tons of resources only a Google search away for you to consume and get deeper insights from.

Don't be tempted to lift off other people's works or articles and pass it off as your own, as this is plagiarism. Rather, use these resources as references and ideas for your work.

Google as much as possible, get facts and figures from research journals, books or news, and gather as much information as you can about your topic. Then you can start making an outline.

Make an outline

Outlining the content of your document before expanding on it helps you write in a more focused way. It also lets you organize your thoughts and achieving your goals for your writing.

An outline can also help you identify what you want your readers to get out of the document. And finally, it establishes a timeline for completing your writing.

Get relevant graphics/images

Having an outline is very helpful in identifying the various virtual aids (infographics, gifs, videos, tweets) you'll need to embed in different sections of your document.

And it'll make your writing process much easier if you keep these relevant graphics handy.

Write in the Correct Style

Finally, you can start to write! If you've completed all these steps, writing should become a lot easier. But you still need to make sure your writing style is suitable for a technical document.

The writing needs to be accessible, direct, and professional. Flowery or emotional text is not welcome in a technical document. To help you maintain this style, here are some key characteristics you should cultivate.

Use Active Voice

It's a good idea to use active voices in your articles, as it is easier to read and understand than the passive voice.

Active voice means that the subject of the sentence is the one actively performing the action of the verb. Passive voice means that a subject is the recipient of a verb's action .

Here's an example of passive voice : The documentation should be read six times a year by every web developer.

And here's an example of active voice : Every web developer should read this documentation 6 times a year.

Choose Your Words Carefully

Word choice is important. Make sure you use the best word for the context. Avoid overusing pronouns such as ‘it’ and ‘this’ as the reader may have difficulty identifying which nouns they refer to.

Also avoid slang and vulgar language – remember you're writing for a wider audience whose disposition and cultural inclinations could differ from yours.

Avoid Excessive Jargon

If you’re an expert in your field, it can be easy to use jargon you're familiar with without realizing that it may be confusing to other readers.

You should also avoid using acronyms you haven't previously explained.

Here's an Example :

Less clear: PWAs are truly considered the future of multi-platform development. Their availability on both Android and iOS makes them the app of the future.

Improved: Progressive Web Applications (PWAs) are truly the future of multi-platform development. Their availability on both Android and iOS makes PWAs the app of the future.

Use Plain Language

Use fewer words and write in a way so that any reader can understand the text.‌‌ Avoid big lengthy words. Always try to explain concepts and terms in the clearest way possible.

Visual Formatting

A wall of text is difficult to read. Even the clearest instructions can be lost in a document that has poor visual representation.

They say a picture is worth a thousand words. This rings true even in technical writing.

But not just any image is worthy of a technical document. Technical information can be difficult to convey in text alone. A well-placed image or diagram can clarify your explanation.

People also love visuals, so it helps to insert them at the right spots. Consider the images below:

First, here's a blog snippet without visuals:

Here's a snippet of same blog, but with visuals:

Adding images to your articles makes the content more relatable and easier to understand. In addition to images, you can also use gifs, emoji, embeds (social media, code) and code snippets where necessary.

Thoughtful formatting, templates, and images or diagrams will also make your text more helpful to your readers. You can check out the references below for a technical writing template from @Bolajiayodeji.

Do a Careful Review

Good writing of any type must be free from spelling and grammatical errors. These errors might seem obvious, but it's not always easy to spot them (especially in lengthy documents).

Always double-check your spelling (you know, dot your Is and cross your Ts) before hitting 'publish'.

There are a number of free tools like Grammarly and the Hemingway app that you can use to check for grammar and spelling errors. You can also share a draft of your article with someone to proofread before publishing.

Where to Publish Your Articles

Now that you've decided to take up technical writing, here are some good platforms where you can start putting up technical content for free. They can also help you build an appealing portfolio for future employers to check out.

Dev.to is a community of thousands of techies where both writers and readers get to meaningfully engage and share ideas and resources.

Hashnode is my go-to blogging platform with awesome perks such as custom domain mapping and an interactive community. Setting up a blog on this platform is also easy and fast.

freeCodeCamp has a very large community and audience reach and is a great place to publish your articles. However, you'll need to apply to write for their publication with some previous writing samples.

Your application could either be accepted or rejected, but don't be discouraged. You can always reapply later as you get better, and who knows? You could get accepted.

If you do write for them, they'll review and edit your articles before publishing, to make sure you publish the most polished article possible. They'll also share your articles on their social media platforms to help more people read them.

Hackernoon has over 7,000 writers and could be a great platform for you to start publishing your articles to the over 200,000 daily readers in the community.

Hacker Noon supports writers by proofreading their articles before publishing them on the platform, helping them avoid common mistakes.

Just like in every other field, there are various processes, rules, best practices, and so on in Technical Writing.

Taking a course on technical writing will help guide you through every thing you need to learn and can also give you a major confidence boost to kick start your writing journey.

Here are some technical writing courses you can check out:

Google Technical Writing Course (Free)
Udemy Technical Writing Course (Paid)
Hashnode Technical Writing Bootcamp (Free)

Technical Writing Forums and Communities

Alone we can do so little, together, we can do so much ~ Helen Keller

Being part of a community or forum along with people who share same passion as you is beneficial. You can get feedback, corrections, tips and even learn some style tips from other writers in the community.

Here are some communities and forums for you to join:

Technical Writing World
Technical Writer Forum
Write the Docs Forum

Some Amazing Technical Writers to follow

In my technical writing journey, I've come and followed some great technical writers whose writing journey, consistency, and style inspire me.

These are the writers whom I look up to and consider virtual mentors on technical writing. Sometimes, they drop technical writing tips that I find helpful and have learned a lot from.

Here are some of those writers (hyperlinked with their twitter handles):

Quincy Larson
Edidiong Asikpo
Catalin Pit
Victoria Lo
Bolaji Ayodeji
Amruta Ranade
Chris Bongers
Colby Fayock

Final words

You do not need a degree in technical writing to start putting out technical content. You can start writing on your personal blog and public GitHub repositories while building your portfolio and gaining practical experience.

Really – Just Start Writing.

Practice by creating new documents for existing programs or projects. There are a number of open source projects on GitHub that you can check out and add to their documentation.

Is there an app that you love to use, but its documentation is poorly written? Write your own and share it online for feedback. You can also quickly set up your blog on hashnode and start writing.

You learn to write by writing, and by reading and thinking about how writers have created their characters and invented their stories. If you are not a reader, don't even think about being a writer. - Jean M. Auel

Technical writers are always learning . By diving into new subject areas and receiving external feedback, a good writer never stops honing their craft.

Of course, good writers are also voracious readers. By reviewing highly-read or highly-used documents, your own writing will definitely improve.

Can't wait to see your technical articles!

Introduction to Technical Writing ‌‌

How to structure a technical article ‌‌

Understanding your audience, the why and how

‌‌ Technical Writing template

I hope this was helpful. If so, follow me on Twitter and let me know!

Amarachi is a front end web developer, technical writer and educator who is interested in building developer communities.

If you read this far, thank the author to show them you care. Say Thanks

Learn to code for free. freeCodeCamp's open source curriculum has helped more than 40,000 people get jobs as developers. Get started

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

7. COMMON DOCUMENT TYPES

7.7 Writing Instructions

One of the most common and important uses of technical writing is to provide instructions, those step-by-step explanations of how to assemble, operate, repair, or do routine maintenance on something. Although they may seems intuitive and simple to write, instructions are some of the worst-written documents you can find. Most of us have probably had many infuriating experiences with badly written instructions. This chapter will show you what professionals consider the best techniques in providing instructions.

An effective set of instruction requires the following:

Clear, precise, and simple writing
A thorough understanding of the procedure in all its technical detail
The ability to put yourself in the place of the reader, the person trying to use your instructions
The ability to visualize the procedure in detail and to capture that awareness on paper
Willingness to test your instructions on the kind of person you wrote them for.

Preliminary Steps

At the beginning of a project to write a set of instructions, it is important to determine the structure or characteristics of the particular procedure you are going to write about. Here are some steps to follow:

1. Do a careful audience and task analysis

Early in the process, define the audience and situation of your instructions. Remember that defining an audience means defining the level of familiarity your readers have with the topic.

2. Determine the number of tasks

How many tasks are there in the procedure you are writing about? Let’s use the term procedure to refer to the whole set of activities your instructions are intended to discuss. A task is a semi-independent group of actions within the procedure: for example, setting the clock on a microwave oven is one task in the big overall procedure of operating a microwave oven.

A simple procedure like changing the oil in a car contains only one task; there are no semi-independent groupings of activities. A more complex procedure like using a microwave oven contains several semi-independent tasks: setting the clock; setting the power level; using the timer; cleaning and maintaining the microwave, among others.

Some instructions have only a single task, but have many steps within that single task. For example, imagine a set of instructions for assembling a kids’ swing set. In my own experience, there were more than a 130 steps! That can be a bit daunting. A good approach is to group similar and related steps into phases, and start renumbering the steps at each new phase. A phase then is a group of similar steps within a single-task procedure. In the swing-set example, setting up the frame would be a phase; anchoring the thing in the ground would be another; assembling the box swing would be still another.

3. Determine the best approach to the step-by-step discussion

For most instructions, you can focus on tasks, or you can focus on tools (or features of tools). In a task approach (also known as task orientation) to instructions on using a phone-answering service, you’d have these sections:

Recording your greeting
Playing back your messages
Saving your messages
Forwarding your messages
Deleting your messages, and so on

These are tasks—the typical things we’d want to do with the machine.

On the other hand, in a tools approach to instructions on using a photocopier, there likely would be sections on how to use specific features:

Copy button
Cancel button
Enlarge/reduce button
Collate/staple button
Copy-size button, and so on

If you designed a set of instructions on this plan, you’d write steps for using each button or feature of the photocopier. Instructions using this tools approach are hard to make work. Sometimes, the name of the button doesn’t quite match the task it is associated with; sometimes you have to use more than just the one button to accomplish the task. Still, there can be times when the tools/feature approach may be preferable.

4. Design groupings of tasks

Listing tasks may not be all that you need to do. There may be so many tasks that you must group them so that readers can find individual ones more easily. For example, the following are common task groupings in instructions:

Unpacking and setup tasks
Installing and customizing tasks
Basic operating tasks
Routine maintenance tasks
Troubleshooting tasks.

Common Sections in Instructions

The following is a review of the sections you’ll commonly find in instructions. Don’t assume that each one of them must be in the actual instructions you write, nor that they have to be in the order presented here, nor that these are the only sections possible in a set of instructions.

For alternative formats, check out the example instructions .

Introduction: plan the introduction to your instructions carefully. It might include any of the following (but not necessarily in this order):

Indicate the specific tasks or procedure to be explained as well as the scope (what will and will not be covered)
Indicate what the audience needs in terms of knowledge and background to understand the instructions
Give a general idea of the procedure and what it accomplishes
Indicate the conditions when these instructions should (or should not) be used
Give an overview of the contents of the instructions.

General warning, caution, danger notices : instructions often must alert readers to the possibility of ruining their equipment, screwing up the procedure, and hurting themselves. Also, instructions must often emphasize key points or exceptions. For these situations, you use special notices —note, warning, caution, and danger notices. Notice how these special notices are used in the example instructions listed above.

Technical background or theory: at the beginning of certain kinds of instructions (after the introduction), you may need a discussion of background related to the procedure. For certain instructions, this background is critical—otherwise, the steps in the procedure make no sense. For example, you may have had some experience with those software applets in which you define your own colors by nudging red, green, and blue slider bars around. To really understand what you’re doing, you need to have some background on color. Similarly, you can imagine that, for certain instructions using cameras, some theory might be needed as well.

Equipment and supplies: notice that most instructions include a list of the things you need to gather before you start the procedure. This includes equipment , the tools you use in the procedure (such as mixing bowls, spoons, bread pans, hammers, drills, and saws) and supplies , the things that are consumed in the procedure (such as wood, paint, oil, flour, and nails). In instructions, these typically are listed either in a simple vertical list or in a two-column list. Use the two-column list if you need to add some specifications to some or all of the items—for example, brand names, sizes, amounts, types, model numbers, and so on.

Discussion of the steps: when you get to the actual writing of the steps, there are several things to keep in mind: (1) the structure and format of those steps, (2) supplementary information that might be needed, and (3) the point of view and general writing style.

Structure and format: normally, we imagine a set of instructions as being formatted as vertical numbered lists. And most are in fact. Normally, you format your actual step-by-step instructions this way. There are some variations, however, as well as some other considerations:

Fixed-order steps are steps that must be performed in the order presented. For example, if you are changing the oil in a car, draining the oil is a step that must come before putting the new oil. These are numbered lists (usually, vertical numbered lists).
Variable-order steps are steps that can be performed in practically any order. Good examples are those troubleshooting guides that tell you to check this, check that where you are trying to fix something. You can do these kinds of steps in practically any order. With this type, the bulleted list is the appropriate format.
Alternate steps are those in which two or more ways to accomplish the same thing are presented. Alternate steps are also used when various conditions might exist. Use bulleted lists with this type, with OR inserted between the alternatives, or the lead-in indicating that alternatives are about to be presented.
Nested steps may be used in cases when individual steps within a procedure are rather complex in their own right and need to be broken down into sub-steps. In this case, you indent further and sequence the sub-steps as a, b, c, and so on.
“Step-less” instructions . can be used when you really cannot use numbered vertical list or provide straightforward instructional-style directing of the reader. Some situations must be so generalized or so variable that steps cannot be stated.

Supplementary discussion: often, it is not enough simply to tell readers to do this or to do that. They need additional explanatory information such as how the thing should look before and after the step; why they should care about doing this step; what mechanical principle is behind what they are doing; even more micro-level explanation of the step—discussion of the specific actions that make up the step.

The problem with supplementary discussion, however, is that it can hide the actual step. You want the actual step—the specific actions the reader is to take—to stand out. You don’t want it all buried in a heap of words. There are at least two techniques to avoid this problem: you can split the instruction from the supplement into separate paragraphs; or you can bold the instruction.

Writing Style

Placing the key user steps in bold can a very helpful way to signal clearly what the reader needs to do. Often the command verb is bolded; sometimes bold font highlights the key component being discussed.

Use of the passive voice in instructions can be problematic. For some strange reason, some instructions sound like this: “The Pause button should be depressed in order to stop the display temporarily.” Not only are we worried about the pause button’s mental health, but we wonder who’s supposed to depress the thing ( ninjas ?). It would be more helpful to indicate when the reader must “ press the Pause button.” Consider this example: “The Timer button is then set to 3:00.” Again, one might ask, “is set by whom? Ninjas ?” The person following these instructions might think it is simply a reference to some existing state, or she might wonder, “Are they talking to me?” Using the third person can also lead to awkwardness: “The user should then press the Pause button.” Instructions should typically be written using command verb forms and using “you” to make it perfectly clear what the reader should do.

Illustrating Your Instructions

Perhaps more than in any other form of technical writing, graphics are crucial to instructions. Sometimes, words simply cannot explain the step. Illustrations are often critical to the readers’ ability to visualize what they are supposed to do. Be sure that the graphics represent the image from the reader’s perspective.

Formatting Your Instructions

Since people rarely want to read instructions, but often have to, format your instructions for reluctant readability. Try to make your reader want to read them, or at least not resistant to the idea of consulting them. Highly readable format will allow readers who have figured out some of the instructions on their own to skip to the section where they are stuck. Use what you have learned about headings , lists , visuals , and passive space to create effective and readable instructions:

Headings : normally, you’d want headings for any background section you might have, the equipment and supplies section, a general heading for the actual instructions section, and subheadings for the individual tasks or phases within that section.

Lists : similarly, instructions typically make extensive use of lists, particularly numbered vertical lists for the actual step-by-step explanations. Simple vertical lists or two-column lists are usually good for the equipment and supplies section. In-sentence lists are good whenever you give an overview of things to come.

Special Notices : you may have to alert readers to possibilities in which they may damage their equipment, waste supplies, cause the entire procedure to fail, injure themselves or others—even seriously or fatally. Companies have been sued for lack of these special notices, for poorly written special notices, or for special notices that were out of place. See special notices for a complete discussion of the proper use of these special notices as well as their format and placement within instructions.

As you reread and revise your instructions, check that they do the following:

Clearly describe the exact procedure to be explained
Provide an overview of content
Indicate audience requirements
Use various types of lists wherever appropriate; in particular, use numbered lists for sequential steps
Use headings and subheadings to divide the main sections and subsections in a logical, coherent order
Use special notices as appropriate
Use graphics to illustrate key actions and objects
Provide additional supplementary explanation of the steps as necessary
Create a section listing equipment and supplies if necessary.

Share This Book

GatherContent is becoming Content Workflow by Bynder. Read More

7 best technical writing examples to improve your skills

Afoma Umesi

Gathercontent contributor, writer, 6 minute read.

Interviewed by:

Lead with Content

How to put content at the centre of digital transformation.

Padma Gillen

Digital Content Consultant

It’s no wonder that technical writing is a fast-growing field.

The Bureau of Labor Statistics predicts that the employment of technical writers will grow up to 12% from 2020 to 2030–a pace that’s faster than the average for all occupations.

If you’re looking to improve your technical writing skills and break into the field but are unsure how to do it, this article will help.

We’ll show you what technical writing is, how to write a technical piece (step by step), and then share some of the best technical writing examples you’ll ever find.

What is technical writing?

Technical writing is any writing designed to explain complex, technical, and specialized information to audiences who may or may not be familiar with them . It is typically used in technical and occupational fields like engineering, robotics, computer hardware and software, medicine, finance, and consumer electronics.

Usually, technical writing falls into one of three categories depending on whom it’s written for:

Consumer-directed technical writing refers to technical content written for end-users or consumers. Good examples include user manuals, employee handbooks, standard operating procedures (SOP), software user documentation (help files), troubleshooting guides, and legal disclaimers .
Expert-to-expert technical writing is written chiefly for a knowledgeable audience. It includes scientific papers, medical case studies, annual business reports, and legal case reviews .
Technical marketing content is technical information presented in a digestible format to promote a product or service. Think marketing case studies, white papers, product brochures, press releases, and business plans and proposals .

Like most types of content , technical writing is complex and nuanced in its own way. Let’s break down the steps to writing technical content that appeals to your audience.

6 Steps to Writing a Technical Piece That People Actually Want to Read

Instruction manuals, assembly guides, and research papers, oh my . Technical writing can quickly turn into a snooze fest if not done correctly.

How do you create a technical piece that people want to read?

1. Identify Your Audience

Knowing your audience is super important, especially when writing technical content.

For example, the new dad learning to build his first crib may have a different level of medical knowledge (and sheer focus) than the experienced doctor reading a medical research paper.

When you have a clear idea of who you expect to read your piece, you can adjust your vocabulary, tone, and framing accordingly.

This allows you to meet your reader at their point of knowledge .

2. Dig Deep in Your Research

As a technical writer, you’ll be guiding your reader through entirely unfamiliar territory.

You might be explaining how a new electronic tool works, what to expect from their new workplace, or what happened before their firm took on a new legal case. It is essential that you fully understand your subject matter .

You can only teach what you know, and knowledge gaps show when you aren’t thorough in your research.

Place yourself in your readers’ shoes. Imagine you had zero knowledge of the topic at hand and ensure your research covers all potential questions that come to mind. ‍

💡 Tip : If you need help understanding your topic, work with subject matter experts. Here are three helpful resources for collaborating with SMEs:

How to create great content with busy Subject Matter Experts
How to collaborate with a Subject Matter Expert
How to get the content you need from subject matter experts

3. Create an Outline

We recommend creating an outline to give you a sense of what you need to cover in your piece. This can also help identify knowledge gaps as you conduct your research.

When you’re writing longer-form content like white papers or case studies, an outline can serve as a marker to remind you of what you need to include .

In lieu of an outline, you can use a template . Some technical writing, such as business plans, have industry-accepted formats, including sections like an executive summary and competitor analysis.

4. Focus on Readability

Technical writing is not creative writing—you're writing to teach, not inspire or entertain. When tackling complicated topics, using readable sentences can make your work more enjoyable to read .

On the other hand, if you’re verbose or use words that are hard to understand, you’ll only frustrate your reader. If you want to improve readability in technical content, try these tips:

Use simple language: Strive for shorter, direct sentences that are easy to follow, and avoid passive voice wherever possible.
Use subheadings: For longer-form content like user documentation, white papers, and research papers , adding subheadings can break up long text walls.
Add bolded sections and callouts: Bolding text and highlighting paragraphs or callouts for emphasis will make reading easier.
Hyperlinks and jump links: If you’re writing technical content for webpages, add hyperlinks to any material you reference and jump links to other sections of your piece for easier navigation.

5. Add Visuals

We’re all about the words and the writing, but visuals can make your technical writing easier to understand! In technical writing, adding visuals is less of a luxury and more of a necessity . Visuals such as flowcharts, screenshots, and illustrations can add a much-needed dose of cheer to text-heavy documents.

Whether you’re creating a user manual or annual report for stakeholders, everyone will be happier with product drawings showing the directions or a pie chart displaying the numbers.

6. Cut the Fluff

When you’ve got all the words on paper, it’s time to double-check the facts with collaborators . Don’t be afraid to cut unnecessary information during this writing phase.

How do you identify the fluff? Removing fluff doesn’t impact the readers’ understanding of your text. It could be a word, a sentence, a paragraph, or a step in the directions. Every word in your technical document should count.

7 of the Best Technical Writing Examples from Technical SMEs

With some help from a few technical content experts, we’ve chosen different forms of technical writing across various industries so you can see the skill in action.

Pipedrive’s Developer Documentation

pipedrive developer documentation - technical writing examples

Developer documentation is essential for technical communication, and Pipedrive does it well. This technical document is geared toward layman product users and must be easy to understand, even while providing complex information. Notice the use of jump links and the callout box on the page.

Outfunnel’s Head of Marketing, Katheriin Liibert says about Pipedrive’s technical writing,

Digimind Consumer Brand Footprint Ranking 2021 Report

Digimind white paper - technical writing examples

Digimind goes the extra mile with their visuals in this white paper/industry report . It’s eye-catching and information–all the while remaining thoroughly professional and readable. Being a B2B brand does not mean boring text-only marketing copy.

University of Wisconsin Onboarding Tool Kit

University of Wisconsin’s onboarding handbook - technical writing examples

This onboarding/employee handbook wins for being easy to read with short sentences and bullet points that improve readability. The human resources department also adds quick links to any relevant documents new employees need to download or fill out.

Cell Reports Medical Study

[Cell medical report - technical writing examples]

Yes, a medical research paper with pictures!

Dr. Sophia Milbourne , a stem cell biologist and freelance science communicator, appreciates that this paper is a “great summary of the subject matter.” More importantly, Milbourne mentions that

LG Refrigerator Manual

[LG user manual - technical writing examples]

This basic user manual from LG gives users an overview of their new product and helps them make the best use of it. (The diagram will come in handy when an online article tells you to adjust the control panel and you’re not sure which knob it is.)

Mashable India’s User Agreement

Mashable India legal user agreement - technical writing examples

This is an excellent example of a consumer-directed technical document. Mashable India’s user agreement is a technical legal document including their disclaimer, use license, and usage conditions.

Lawyer and content writer Ejike Umesi acknowledges that the company follows the numbered styling typical of these documents. He says,

Slack Help Center

The Slack Help Center is an excellent example of technical writing that speaks to the layman. Slack is known for its brilliant UX copywriting . Amruta Ranade, Staff Technical Writer for Airbyte, admires the company’s documentation writing style.

“Slack’s Help Center shows incredible user-awareness. The information displayed is contextual, concise, and complete–it helps the user accomplish their task without distracting them or sidetracking them with extraneous information.”

Ramp Up Your Technical Writing

Whether you’re looking to set up a personalized template or collaborate with multiple editors in real-time , GatherContent helps you elevate your technical writing workflow.

With GatherContent, you can build templates for any content you create, including case studies! GatherContent also has helpful resources for helping you and your team prioritize user-led content .

If you publish your content online , you can connect GatherContent to your CMS of choice for seamless exporting. Planning, creating, and sharing great technical content doesn’t have to be so… technical.

Start your GatherContent free trial today.

Content Creation: The Essential Guide

Practical advice to help you create effective content for your audience and your business..

About the author

Related posts you might like, platform features.

Content Hub
Content Project Management
Content Planning
Content Templates
Content Style Guides
Content Management
Content Workflow
Content Calendar
Content Creation & Collaboration
Beta Features
What's New
Productivity
Integrations
What is ContentOps?
Resources and Events
Our Partners
Customer Advisory Board
Join our team
Security & Backups
Terms of Service Data Processing Agreement
Terms of Website Use
Global Privacy Policy
Cookie Policy
Help Centre
API Documentation

Sign up to our weekly newsletter

The Writing Center • University of North Carolina at Chapel Hill

Understanding Assignments

What this handout is about.

The first step in any successful college writing venture is reading the assignment. While this sounds like a simple task, it can be a tough one. This handout will help you unravel your assignment and begin to craft an effective response. Much of the following advice will involve translating typical assignment terms and practices into meaningful clues to the type of writing your instructor expects. See our short video for more tips.

Basic beginnings

Regardless of the assignment, department, or instructor, adopting these two habits will serve you well :

Read the assignment carefully as soon as you receive it. Do not put this task off—reading the assignment at the beginning will save you time, stress, and problems later. An assignment can look pretty straightforward at first, particularly if the instructor has provided lots of information. That does not mean it will not take time and effort to complete; you may even have to learn a new skill to complete the assignment.
Ask the instructor about anything you do not understand. Do not hesitate to approach your instructor. Instructors would prefer to set you straight before you hand the paper in. That’s also when you will find their feedback most useful.

Assignment formats

Many assignments follow a basic format. Assignments often begin with an overview of the topic, include a central verb or verbs that describe the task, and offer some additional suggestions, questions, or prompts to get you started.

An Overview of Some Kind

The instructor might set the stage with some general discussion of the subject of the assignment, introduce the topic, or remind you of something pertinent that you have discussed in class. For example:

“Throughout history, gerbils have played a key role in politics,” or “In the last few weeks of class, we have focused on the evening wear of the housefly …”

The Task of the Assignment

Pay attention; this part tells you what to do when you write the paper. Look for the key verb or verbs in the sentence. Words like analyze, summarize, or compare direct you to think about your topic in a certain way. Also pay attention to words such as how, what, when, where, and why; these words guide your attention toward specific information. (See the section in this handout titled “Key Terms” for more information.)

“Analyze the effect that gerbils had on the Russian Revolution”, or “Suggest an interpretation of housefly undergarments that differs from Darwin’s.”

Additional Material to Think about

Here you will find some questions to use as springboards as you begin to think about the topic. Instructors usually include these questions as suggestions rather than requirements. Do not feel compelled to answer every question unless the instructor asks you to do so. Pay attention to the order of the questions. Sometimes they suggest the thinking process your instructor imagines you will need to follow to begin thinking about the topic.

“You may wish to consider the differing views held by Communist gerbils vs. Monarchist gerbils, or Can there be such a thing as ‘the housefly garment industry’ or is it just a home-based craft?”

These are the instructor’s comments about writing expectations:

“Be concise”, “Write effectively”, or “Argue furiously.”

Technical Details

These instructions usually indicate format rules or guidelines.

“Your paper must be typed in Palatino font on gray paper and must not exceed 600 pages. It is due on the anniversary of Mao Tse-tung’s death.”

The assignment’s parts may not appear in exactly this order, and each part may be very long or really short. Nonetheless, being aware of this standard pattern can help you understand what your instructor wants you to do.

Interpreting the assignment

Ask yourself a few basic questions as you read and jot down the answers on the assignment sheet:

Why did your instructor ask you to do this particular task?

Who is your audience.

What kind of evidence do you need to support your ideas?

What kind of writing style is acceptable?

What are the absolute rules of the paper?

Try to look at the question from the point of view of the instructor. Recognize that your instructor has a reason for giving you this assignment and for giving it to you at a particular point in the semester. In every assignment, the instructor has a challenge for you. This challenge could be anything from demonstrating an ability to think clearly to demonstrating an ability to use the library. See the assignment not as a vague suggestion of what to do but as an opportunity to show that you can handle the course material as directed. Paper assignments give you more than a topic to discuss—they ask you to do something with the topic. Keep reminding yourself of that. Be careful to avoid the other extreme as well: do not read more into the assignment than what is there.

Of course, your instructor has given you an assignment so that he or she will be able to assess your understanding of the course material and give you an appropriate grade. But there is more to it than that. Your instructor has tried to design a learning experience of some kind. Your instructor wants you to think about something in a particular way for a particular reason. If you read the course description at the beginning of your syllabus, review the assigned readings, and consider the assignment itself, you may begin to see the plan, purpose, or approach to the subject matter that your instructor has created for you. If you still aren’t sure of the assignment’s goals, try asking the instructor. For help with this, see our handout on getting feedback .

Given your instructor’s efforts, it helps to answer the question: What is my purpose in completing this assignment? Is it to gather research from a variety of outside sources and present a coherent picture? Is it to take material I have been learning in class and apply it to a new situation? Is it to prove a point one way or another? Key words from the assignment can help you figure this out. Look for key terms in the form of active verbs that tell you what to do.

Key Terms: Finding Those Active Verbs

Here are some common key words and definitions to help you think about assignment terms:

Information words Ask you to demonstrate what you know about the subject, such as who, what, when, where, how, and why.

define —give the subject’s meaning (according to someone or something). Sometimes you have to give more than one view on the subject’s meaning
describe —provide details about the subject by answering question words (such as who, what, when, where, how, and why); you might also give details related to the five senses (what you see, hear, feel, taste, and smell)
explain —give reasons why or examples of how something happened
illustrate —give descriptive examples of the subject and show how each is connected with the subject
summarize —briefly list the important ideas you learned about the subject
trace —outline how something has changed or developed from an earlier time to its current form
research —gather material from outside sources about the subject, often with the implication or requirement that you will analyze what you have found

Relation words Ask you to demonstrate how things are connected.

compare —show how two or more things are similar (and, sometimes, different)
contrast —show how two or more things are dissimilar
apply—use details that you’ve been given to demonstrate how an idea, theory, or concept works in a particular situation
cause —show how one event or series of events made something else happen
relate —show or describe the connections between things

Interpretation words Ask you to defend ideas of your own about the subject. Do not see these words as requesting opinion alone (unless the assignment specifically says so), but as requiring opinion that is supported by concrete evidence. Remember examples, principles, definitions, or concepts from class or research and use them in your interpretation.

assess —summarize your opinion of the subject and measure it against something
prove, justify —give reasons or examples to demonstrate how or why something is the truth
evaluate, respond —state your opinion of the subject as good, bad, or some combination of the two, with examples and reasons
support —give reasons or evidence for something you believe (be sure to state clearly what it is that you believe)
synthesize —put two or more things together that have not been put together in class or in your readings before; do not just summarize one and then the other and say that they are similar or different—you must provide a reason for putting them together that runs all the way through the paper
analyze —determine how individual parts create or relate to the whole, figure out how something works, what it might mean, or why it is important
argue —take a side and defend it with evidence against the other side

More Clues to Your Purpose As you read the assignment, think about what the teacher does in class:

What kinds of textbooks or coursepack did your instructor choose for the course—ones that provide background information, explain theories or perspectives, or argue a point of view?
In lecture, does your instructor ask your opinion, try to prove her point of view, or use keywords that show up again in the assignment?
What kinds of assignments are typical in this discipline? Social science classes often expect more research. Humanities classes thrive on interpretation and analysis.
How do the assignments, readings, and lectures work together in the course? Instructors spend time designing courses, sometimes even arguing with their peers about the most effective course materials. Figuring out the overall design to the course will help you understand what each assignment is meant to achieve.

Now, what about your reader? Most undergraduates think of their audience as the instructor. True, your instructor is a good person to keep in mind as you write. But for the purposes of a good paper, think of your audience as someone like your roommate: smart enough to understand a clear, logical argument, but not someone who already knows exactly what is going on in your particular paper. Remember, even if the instructor knows everything there is to know about your paper topic, he or she still has to read your paper and assess your understanding. In other words, teach the material to your reader.

Aiming a paper at your audience happens in two ways: you make decisions about the tone and the level of information you want to convey.

Tone means the “voice” of your paper. Should you be chatty, formal, or objective? Usually you will find some happy medium—you do not want to alienate your reader by sounding condescending or superior, but you do not want to, um, like, totally wig on the man, you know? Eschew ostentatious erudition: some students think the way to sound academic is to use big words. Be careful—you can sound ridiculous, especially if you use the wrong big words.
The level of information you use depends on who you think your audience is. If you imagine your audience as your instructor and she already knows everything you have to say, you may find yourself leaving out key information that can cause your argument to be unconvincing and illogical. But you do not have to explain every single word or issue. If you are telling your roommate what happened on your favorite science fiction TV show last night, you do not say, “First a dark-haired white man of average height, wearing a suit and carrying a flashlight, walked into the room. Then a purple alien with fifteen arms and at least three eyes turned around. Then the man smiled slightly. In the background, you could hear a clock ticking. The room was fairly dark and had at least two windows that I saw.” You also do not say, “This guy found some aliens. The end.” Find some balance of useful details that support your main point.

You’ll find a much more detailed discussion of these concepts in our handout on audience .

The Grim Truth

With a few exceptions (including some lab and ethnography reports), you are probably being asked to make an argument. You must convince your audience. It is easy to forget this aim when you are researching and writing; as you become involved in your subject matter, you may become enmeshed in the details and focus on learning or simply telling the information you have found. You need to do more than just repeat what you have read. Your writing should have a point, and you should be able to say it in a sentence. Sometimes instructors call this sentence a “thesis” or a “claim.”

So, if your instructor tells you to write about some aspect of oral hygiene, you do not want to just list: “First, you brush your teeth with a soft brush and some peanut butter. Then, you floss with unwaxed, bologna-flavored string. Finally, gargle with bourbon.” Instead, you could say, “Of all the oral cleaning methods, sandblasting removes the most plaque. Therefore it should be recommended by the American Dental Association.” Or, “From an aesthetic perspective, moldy teeth can be quite charming. However, their joys are short-lived.”

Convincing the reader of your argument is the goal of academic writing. It doesn’t have to say “argument” anywhere in the assignment for you to need one. Look at the assignment and think about what kind of argument you could make about it instead of just seeing it as a checklist of information you have to present. For help with understanding the role of argument in academic writing, see our handout on argument .

What kind of evidence do you need?

There are many kinds of evidence, and what type of evidence will work for your assignment can depend on several factors–the discipline, the parameters of the assignment, and your instructor’s preference. Should you use statistics? Historical examples? Do you need to conduct your own experiment? Can you rely on personal experience? See our handout on evidence for suggestions on how to use evidence appropriately.

Make sure you are clear about this part of the assignment, because your use of evidence will be crucial in writing a successful paper. You are not just learning how to argue; you are learning how to argue with specific types of materials and ideas. Ask your instructor what counts as acceptable evidence. You can also ask a librarian for help. No matter what kind of evidence you use, be sure to cite it correctly—see the UNC Libraries citation tutorial .

You cannot always tell from the assignment just what sort of writing style your instructor expects. The instructor may be really laid back in class but still expect you to sound formal in writing. Or the instructor may be fairly formal in class and ask you to write a reflection paper where you need to use “I” and speak from your own experience.

Try to avoid false associations of a particular field with a style (“art historians like wacky creativity,” or “political scientists are boring and just give facts”) and look instead to the types of readings you have been given in class. No one expects you to write like Plato—just use the readings as a guide for what is standard or preferable to your instructor. When in doubt, ask your instructor about the level of formality she or he expects.

No matter what field you are writing for or what facts you are including, if you do not write so that your reader can understand your main idea, you have wasted your time. So make clarity your main goal. For specific help with style, see our handout on style .

Technical details about the assignment

The technical information you are given in an assignment always seems like the easy part. This section can actually give you lots of little hints about approaching the task. Find out if elements such as page length and citation format (see the UNC Libraries citation tutorial ) are negotiable. Some professors do not have strong preferences as long as you are consistent and fully answer the assignment. Some professors are very specific and will deduct big points for deviations.

Usually, the page length tells you something important: The instructor thinks the size of the paper is appropriate to the assignment’s parameters. In plain English, your instructor is telling you how many pages it should take for you to answer the question as fully as you are expected to. So if an assignment is two pages long, you cannot pad your paper with examples or reword your main idea several times. Hit your one point early, defend it with the clearest example, and finish quickly. If an assignment is ten pages long, you can be more complex in your main points and examples—and if you can only produce five pages for that assignment, you need to see someone for help—as soon as possible.

Tricks that don’t work

Your instructors are not fooled when you:

spend more time on the cover page than the essay —graphics, cool binders, and cute titles are no replacement for a well-written paper.
use huge fonts, wide margins, or extra spacing to pad the page length —these tricks are immediately obvious to the eye. Most instructors use the same word processor you do. They know what’s possible. Such tactics are especially damning when the instructor has a stack of 60 papers to grade and yours is the only one that low-flying airplane pilots could read.
use a paper from another class that covered “sort of similar” material . Again, the instructor has a particular task for you to fulfill in the assignment that usually relates to course material and lectures. Your other paper may not cover this material, and turning in the same paper for more than one course may constitute an Honor Code violation . Ask the instructor—it can’t hurt.
get all wacky and “creative” before you answer the question . Showing that you are able to think beyond the boundaries of a simple assignment can be good, but you must do what the assignment calls for first. Again, check with your instructor. A humorous tone can be refreshing for someone grading a stack of papers, but it will not get you a good grade if you have not fulfilled the task.

Critical reading of assignments leads to skills in other types of reading and writing. If you get good at figuring out what the real goals of assignments are, you are going to be better at understanding the goals of all of your classes and fields of study.

You may reproduce it for non-commercial use if you use the entire handout and attribute the source: The Writing Center, University of North Carolina at Chapel Hill

Make a Gift

Module 2: Proposals and Reports

5. proposals.

This chapter focuses on the proposal—the kind of document that gets you or your organization approved or hired to do a project. In this course, you will write a research proposal—a proposal to conduct research and provide a report detailing the results of your research. Then you’ll write a progress report updating your audience on your progress while you are engaged in conducting the research, and finally you will write the report itself (also called the project deliverable ). Reports are covered later in the course. For now, let’s look at the first step: the proposal.

Preliminary research is essential when writing proposals.

Some Preliminaries

A proposal is an offer or bid to do a project. Proposals may contain other elements—technical background, recommendations, results of surveys, information about feasibility, and so on. But what makes a proposal a proposal is that it asks the audience to approve, fund, or grant permission to do the proposed project.

The proposal assignment in this course offers practice writing a proposal directed to a specific organization of your choosing. (The organization can be fictitious or real.) Your proposal should address a problem or opportunity faced by the organization (your audience), and should focus on conducting research on the problem or opportunity and preparing a report on the results of your research. After your proposal is approved, you will conduct the research and write the report, based on your research findings, that puts forth a possible solution to the problem or offers a suggestion for taking advantage of the opportunity.

A proposal should contain information that will enable your audience to decide whether to approve the project and hire you to do the work. To write a successful proposal, put yourself in the place of your audience—the recipient of the proposal—and think about what information that audience needs to feel confident having you do the project.

It is easy to get confused about proposals. Imagine that you have a terrific idea for installing some new technology where you work and you write up a document explaining how the technology works and why it would benefit the company, urging management to go for it. Is that a proposal? No, it’s not. It’s more like a feasibility or recommendation report, which studies the merits of a project and then recommends for or against it. Certainly, some proposals must sell the projects they offer to do, but in all cases proposals must sell the writer (or the writer’s organization) as the one to do the project.

Types of proposals

Consider the situations in which proposals occur. A company may send out a public announcement requesting proposals for a specific project. This public announcement—called a request for proposals (RFP)—could be issued through newspapers, trade journals, websites, or email. Firms or individuals interested in the project then write proposals in which they summarize their qualifications, estimate costs, create schedules, and discuss their approach to the project. The recipient of all these proposals evaluates them, selects the best candidate, and enters into an agreement with the organization or individual who submitted the proposal. This type of proposal is a solicited , external proposal.

But proposals can come about much less formally. Imagine that you are interested in doing a project at work (for example, investigating the merits of bringing in some new technology to increase productivity). Imagine that you visit your supervisor and try to convince her of this. She might respond by saying, “Write me a proposal and I’ll present it to upper management.” This type of proposal is an unsolicited , internal proposal.

Internal Proposal vs. External Proposal

An external proposal is written from one separate, independent organization or individual to another such entity. The typical example is the independent consultant proposing to do a project for another firm. A proposal submitted by someone who works for an organization, as in the second scenario, is an internal proposal. Internal proposals may not require as much detail or information as external proposals since your audience might already know your qualifications and may be familiar with the situation you are proposing to address.

Solicited Proposals vs. Unsolicited Proposals

A solicited proposal is one in which the recipient has requested the proposal, such as in the case where a Request for Proposals was sent out. In the example above involving the boss who asks for a proposal that offers to do a formal study of your idea about new technology for the company, the proposal might be seen as unsolicited since you came up with the idea and approached your boss about it, but it is in a sense also solicited since your boss asked you to write up the formal document. Figure 1, below, shows the logistics of proposals.

Figure 1. Types of Proposals. (Image author-created)

Few proposals are truly unsolicited, as the time and expense of writing a proposal makes people reluctant to undertake them without some assurance that there is a sincere audience for the proposal. And unsolicited proposals in particular must make a strong argument in the proposal introduction to persuade the recipient that a problem or opportunity exists and research is worth the investment.

Research Proposals vs. Goods-and-Services Proposals

There are two major types of proposals: the research proposal, and the goods-and-services proposal . We are concerned here with the research proposal, in which you propose to conduct research on a problem or opportunity for an organization. After your proposal is approved, you will conduct the research and write a report that provides the results of your research and your conclusions about your research. Your report is called the deliverable (the analytical information you will deliver.) The other category of deliverable, goods and services, results when a person or company proposes to supply a product other than information—such as a fleet of jets or a new bridge—or a service, such as janitorial services for an airport or maintenance for that new bridge.

Typical Scenarios for the Proposal

It gets a bit tricky dreaming up a good technical report project and then creating a proposal that seeks approval to conduct the research and write that report. Here are some ideas:

Imagine that a nonprofit organization focused on a particular issue wants an expert consultant to write a brochure or guide for its membership. This document will present information on the issue in a way that the members can understand. You submit a proposal to write the brochure/guide.
Imagine that a company has some sort of problem or wants to make some sort of improvement. It sends out a request for proposals; you receive one and respond with a proposal. You offer to research, investigate, interview, and make recommendations—and present it all in the form of a report.
Imagine that an organization wants a seminar in your area of expertise. You write a proposal to give the seminar—included in the package deal is a guide or handbook that the people attending the seminar will receive.

Though you may have written academic research proposals, technical writing proposals differ considerably from those. Technical writing proposals focus on real-world scenarios and should not address legal issues (such as proposing to change a law), religious beliefs or personal values, or strictly academic subjects, such as history or literature. You may well use academic information sources in conducting research and writing your report, but the report should focus on a real-world situation involving a company or organization. (You can create a fictitious company or organization for your proposal.)

Common Sections in Proposals

Though proposals may vary a great deal from one organization to another, they generally follow a common format that includes specific kinds of information. When referring to your proposal assignment, you may discover that other kinds of information not mentioned here must be included in your particular proposal. At a minimum, your research proposal should include each of the sections described below. Check with your instructor for details regarding your particular proposal assignment.

Introduction. Plan the introduction to your proposal carefully. Make sure it does all of the following:

Indicates that the document is a proposal
Refers to the problem or opportunity that you will research and address in your report
Includes a motivating statement to convince the recipient to read your proposal and consider giving approval for you to do the research and write the report
Gives an overview of the contents of the report you will write if your proposal is accepted

Background on the problem or opportunity. Discuss the need for the project—what problem or opportunity exists at the organization. For example:

The owner of a resort may be trying to boost his business but feel uncertain of how to go about it.
A veterinarian may be using outdated X-ray equipment in her clinic.
A taxi service may be considering replacing its fleet of cars with hybrid models to try to cut fuel costs.

The audience of the proposal may know the problem very well, in which case this section might not be lengthy. But the background section should demonstrate your particular view of the problem and convince the audience that conducting the proposed research to address the problem or opportunity merits the organization’s investment of time and/or money.

Program Description. This section is where you explain the proposed work: what you plan to do and how you will achieve your end result— the deliverable . This includes describing the document you are proposing to write; specifying its audience and purpose; and discussing such things as its length, graphics, binding, and so forth. In the scenario you create for your project, there may be other work such as conducting training seminars or providing an ongoing service. Also discuss the benefits of doing the proposed project. This acts as an argument in favor of approving the proposal. Include your preliminary research, quoting and citing sources, to justify your plan of action.

In the resort proposal listed above, you could propose that the resort owner consider the costs and benefits of updating the amusement options for guests, such as adding windsurfing or some other option on the resort’s private lake. For the veterinarian, you might propose to research the costs and benefits of purchasing new X-ray equipment and write a report with the results of your research and a recommendation regarding which are the top three models to consider. In an unsolicited proposal, this section is particularly important—you are trying to convince the audience that the project can benefit them and that conducting the research is worth the cost.

Procedure. In this section you’ll explain how you will do the proposed work. This acts as an additional persuasive element; it shows the audience you have a sound, well-thought-out approach to the project. Also, it serves as the other form of background some proposals need. Remember that the background section (the one discussed above) focused on the problem or need that brings about the proposal. In this section, you discuss the technical background relating to the procedures or technology you plan to use in the proposed work. For example, in the X-ray proposal, the writer gives a bit of background on how X-rays are used in the veterinarian’s office and the impact that using outdated equipment has on the employees, the animals, the clients, and the practice itself. Once again, this gives you—the proposal writer—a chance to show that you know what you are talking about and to show your audience why they should approve your proposal. You should include a list of specific tasks that you will undertake in conducting your research.

Schedule. This section should show not only the projected completion date but also key milestones for the project. In creating your schedule, refer to the Procedure section and link tasks to specific dates. Let your audience know when you will complete tasks. Some of these tasks may overlap. If you are doing a large project spreading over many months, the timeline would also show dates on which you would deliver progress reports. One effective way to display the schedule is to use a Gantt Chart or similar graphic that visually links each proposed task to a specific date or time period. (See the annotated research proposal link in the Proposal Format section below for details.)

Qualifications/Experience. This section should include a brief summary of your education and experience. a mini-résumé focused on the experience you have that is relevant to the project. This section, too, is an opportunity to persuade your audience that you are qualified to do the work.

Budget. Whether the proposal is internal or external, the budget should detail the costs of the project. For external projects, you may need to list your hourly rates, projected hours, costs of equipment and supplies, and so forth, and then calculate the total cost of the complete project. Internal projects of course are not free, and you should still list the project costs: for example, hours you will need to conduct the research, equipment and supplies you’ll be using, assistance from other people in the organization, travel expenses, and so on.

Conclusion. The final section of the proposal should bring readers back to a focus on the positive aspects of the project. End by reminding your audience of the benefits of the project, and perhaps add a detail or two about why you or your organization are the best candidates for the job.

Appendix. Remember that the preceding sections are typical in written proposals, but ask yourself what else your audience might need to understand the project, the need for it, the benefits arising from it, your role in it, and your qualifications. If you are planning to circulate a survey as part of your project, you could include a copy of the actual survey in this section. At the minimum, this section should include a sufficiently detailed outline for the report you will write at the conclusion of your research.

References/Works Cited. Typically, you will need to conduct preliminary research in order to write a persuasive proposal. Your references page should include citations for all outside sources quoted in your proposal. Format your citations in either MLA or APA format.

ORGANIZATION OF PROPOSALS

Notice the overall logic of the movement through these sections: you generate interest about a problem or opportunity, then you explain how you’ll fix the problem or help the organization take advantage of the opportunity, and then you show them what good qualifications you have. Finally, you discuss the costs—but come right back around to the good points about the project and how it will benefit your audience.

PROPOSAL FORMAT

Consolidated memo proposal: In this format, you consolidate the entire proposal in a memo. Include headings and other special formatting elements as if it were a report. To see an example of a research proposal in the consolidated memo format, click on the document link below:

Proposal-Annotated – EmployeeWellnessProgram

Special Assignment Requirements

Remember that, in a technical writing course, the proposal assignment serves several purposes: (1) to give you some experience writing a proposal; (2) to get you started planning your major paper for the course; (3) to give your instructor a chance to work with you on your report project to ensure you’ve got something workable.

Here’s a checklist of what to include somewhere in the proposal:

Audience : Describe the audience of the proposal and the proposed report in terms of the organization they work for, their titles and jobs, their technical background, their ability to understand the report you propose to write.
Purpose : Describe the situation you are proposing to research and write a report about. What is the problem or opportunity and how will you address it?
Report type : Explain what type of report you intend to write: is it a recommendation report? A feasibility report? Provide enough explanation so that your instructor can see that you understand the type of report you are proposing to write.
Information sources : List at least three information sources you will use in conducting your research; make sure there is adequate, reliable information for your topic; list specific books, articles, reference works, or other suitable sources that you will quote and cite in your report.
Graphics : List graphics you think your report will need according to their type and content. (If you can’t think of any your report would need, you may not have a good topic—do some brainstorming with your instructor.)
Outline : Include an outline of the topics and subtopics you plan to cover in your report.

REVISION CHECKLIST FOR PROPOSALS

As you reread and revise your proposal, be sure that you:

Use the memo format.
Write a good introduction.
Identify exactly what you are proposing to do.
Make sure that a report—a written document—is somehow involved in the project you are proposing to do. Remember that in a technical writing course we are trying to do two things: write a proposal and plan the report you will write. Your final report—the deliverable—is your major paper for the course.
Organize the sections in a logical, natural order. For example, don’t hit the audience with schedules and costs before you’ve gotten them interested in the project. Use headers to separate each section of the memo.
Break out the budget section into specifics: include hourly rates and estimated number of hours you will spend on conducting research, and any other anticipated costs. Don’t just hit your audience with a single number.
Include your qualifications—imagine your proposal will go to somebody in the organization who doesn’t know you.
Address the proposal to the real or realistic audience—not your instructor. (You can use your instructor’s name as the CEO or supervisor of the organization.)
Watch out for technobabble (or any other kind of jargon). Some of your proposal readers may know the technical side of your project—but others may not. Challenge yourself to bring difficult technical concepts down to a level that nonspecialists can understand.
Proofread. A professional document is free of careless grammar and spelling errors. We all make typos, but do your best to catch them by running a spelling/grammar check on your document before submitting it.
This chapter is a derivative of Online Technical Writing by Dr. David McMurrey. Located at : https://www.prismnet.com/~hcexres/textbook/ . License : CC BY-NC-SA: Attribution-NonCommercial-ShareAlike . License Terms : Technical Writing Essentials by Kim Wozencraft is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License, except where otherwise indicated.

CH 7 Assignment: Technical Descriptions

A technical description is a part-by-part explanation of an item. Technical descriptions provide users information about a product’s features and capabilities and explain how that product works. Technical communication relies heavily on descriptions for a variety of documents, such as manuals, procedures, reports, and white papers.

For this assignment, your task is to write a technical description of an item , including what it is, what it does, and how it works.

Step 1: Choose an item that performs a task . Choose something that provides a challenge but is also manageable. Some examples include: a flash drive, a lawn mower engine, an air-impact wrench, an app or operating system (Android, iOS, Windows), a musical instrument, or any other item(s) you can think of that does something.

*NOTE : Be sure to be objective in your description; in other words, keep your opinions about the item to yourself.

Step 2: Research the item . Find out what the parts are called and what task(s) the item performs. Note the terminology used, and make use of this terminology in your description (be sure to cite your sources when necessary).

Step 3: Define your audience . Are you writing to the general public or to a specific audience? What does your audience know already? What do they need to know? Why should they care?

Step 4: Write a description of the item (350-500 words). Successful descriptions will include:

A clear technical definition (written in your own words ), which is a one to three-sentence definition of what the item is: The Call-o-Matic 6000 is a… ;
A discussion of the item’s purpose and importance (or context);
An overview of the item’s appearance (size, weight, color, etc.), including its major components;
A logically-organized description —organized either spatially (moving from top to bottom or front to back, for example) or by function (looking at the item’s different components or features or looking at what the item does overall);
A clear understanding of the relationship of each of the components to the others (if applicable);
A clear sense of the intended audience ; and
Clear and concise writing throughout.

*NOTE : No visual aids should be used for this assignment.

How to Write Technical Guides

Published on Nov 19, 2021 in processes by Kasper Siig 5 minute read

Once you embark on the journey of technical writing, you will discover a few different types of articles. Tutorials, comparisons, roundups, and guides. These all serve a different purpose, and your angle will be slightly different depending on which type you are writing. When writing a technical guide, you need to make sure that you are hitting the right mark and that it makes sense to write a guide instead of a tutorial.

In this article, you will be shown what it means to write a technical guide, why you would want to do so, and you’ll be given some tips on how to make great ones.

Why Write Technical Guides?

The first question you always need to ask yourself is why. Why do you want to write technical guides? Below are a few reasons for it.

1. SEO (Search Engine Optimization)

The first reason for writing technical guides is shared among many different types of articles, and it is, of course, SEO. By writing technical guides, you have the opportunity to include specific keywords, which can be a great way of getting ranked higher on search engines like Google.

Besides using keywords, you can use guides as umbrella articles for other articles on your blog. For example, if you create a guide on how to get started with your product, you can link to specific tutorials on each subject. This will keep the reader contained within your blog and increase traffic on your site.

2. Hitting Your Target Audience

Sometimes you are lucky that your target audience quickly picks up on what you are doing, and you don’t need to explain anything to them. This, however, is not the case for most companies. Usually, you need to make your audience understand why they should listen to you.

By making high-level guides, you are introducing people to your product in an easily digestible manner. It’s uncommon that anyone would sit and read a tutorial for a product they are only considering using. It’s even more uncommon if they don’t even consider using your product. When you produce entry-level technical guides, you allow your audience to digest your product without them feeling like they are doing a deep dive into the mechanics of it all.

3. Spread Knowledge of Your Product

Of course, technical guides do not only have to be entry-level. There’s a definite value in making more complex guides, like how your product integrates with other products and concepts that are only relevant to those already working with your product. This can be very valuable, as it again introduces your audience to something in a digestible manner. Many prefer to read a well-written guide rather than sifting through documentation.

4. Let People Get Started Quicker

This last point is somewhat of a combination of the previous two. By writing technical guides, you let people get started with your product quicker than if they had to figure everything out independently. You may think, “Well, that’s why we have documentation,” and while that is correct, the documentation doesn’t serve the same purpose as guides.

Your guides should be written with a clear goal. “Getting started with X using Y.” This allows readers to find a complete overview of what they need. Documentation will usually include more technical explanations, specific implementations and is generally written much more technically than a guide. A guide leads the reader down one particular path, rather than covering many different scenarios, like documentation typically would.

Tips for Writing Great Technical Tutorials

So, you know why you want to start writing technical guides. Now you need to know the building blocks of great articles.

1. Know Your Audience

Like SEO, this is a point shared among many different types of articles, but that is only because of how important it is. Without knowing your audience, you are writing blind. In the context of content marketing, it’s the equivalent of having the dart arrow without knowing where the dartboard is.

Determining the audience helps you keep a thread throughout your article, and it helps keep you in line. If your guide is aimed at experienced developers, you can use industry terms to describe certain things. If your guide is aimed towards a general audience, you know that you need to keep industry terms to a minimum.

2. Focus on the “Why”

Many writers miss, especially when first starting, that they only explain how things are done. While this can, without a doubt, be beneficial, it doesn’t teach the reader very much. The reader might come away with an explanation of the issue at hand, but they still won’t know why they had the problem in the first place.

Maybe your guide isn’t trying to solve an issue. Perhaps it’s a guide on how to get started. In this case, you must hammer home why the reader needs to use your product. Answering the why, even if the reader hasn’t asked it, will generally always lead to a better article. Not only because there’s more substance, but because you as the writer will have to think about the subject more.

3. Having a Clear Goal

Like with the audience, you also need to set a clear goal for the guide. This will help you keep a common thread throughout the article, eventually leading to a better article. Writing a guide that jumps from point a to point c to point b can have valuable insights, but it will be a mess to read. By aligning the article with a clear goal, you can set a direction and make sure the contents are digestible.

4. Keep it High-Level

The last thing to keep in mind is that you are writing a guide and not a tutorial. Keeping it high-level doesn’t mean you can’t mention specific implementation steps or include code snippets. It means that you shouldn’t be including step-by-step instructions on how to get something working.

This is something that should be built into the goal you set. Most of the time, your goal will be something along the lines of helping the reader get introduced to a subject, more so than helping the reader get something implemented.

Now you know more about what it means to write a technical guide compared to writing a technical tutorial or roundup. It’s a matter of making sure the content is digestible and is open to new members of the audience you are targeting.

On top of that, you’ve got an insight into how you can build a fantastic guide, like setting a goal and focusing on the “why.”

Want to write for Draft.dev? Click here to learn more and apply today .

On the other hand, if you need help writing technical guides, or if you’d like to work with our team of writers to build content that reaches software engineers, contact us today

By Kasper Siig

As a DevOps enthusiast and general lover of learning, Kasper is used to working with a variety of exciting technologies, from automating simple tasks to CI/CD to Docker.

Assignment Design

The most updated lab writing instructional modules are available: engineeringlabwriting.org

Learning Objectives

Although all engineering instructors “know how to write”, they may struggle with assigning writing projects to students. Well-designed writing assignments lead directly to student learning. Traci Gardner from National Council of Teachers of English identifies three goals for a writing assignment:

Define the writing task.
Explore the expectations.
Provide supporting materials and activities.

In the context of lab report writing, engineering instructors need to address the following to students as explicitly as possible when preparing lab report assignment:

The audience (Specific people like instructors? engineers? peers? public?).
The pedagogical purpose of the lab report (Why is the assignment given?).
The “fictitious” professional purpose of the lab report (Why is the assignment given?).
Specific requirements (if there are any).
Checklists or Presentation Expectations (format, submission, deadline, etc.).
Assessment rubrics (or any type of grading guidelines): The details of assessment rubric design and development are introduced in the Lab Report Assessment Rubric Module Assessment Rubric Design .
Acceptable sample reports with or without addressing the standard conventions of finished and edited texts.
Unacceptable sample reports with or without addressing the standard conventions of finished and edited texts.
List of recommended reading resources.
Other resources to assist students’ writing process.

Sample 1: Lab Report (as a Technical Report) Writing Assignment

Overview: You (the writer of the report), a 2nd year engineering student, are assigned to write a technical report (the genre) to convey engineering and technical information, including the lab background, process, data, analysis results, and conclusion (the purpose of the report), to the instructor, the TA, and the peers (the audience of the report).
Lab Report Audience: Assume you are submitting the lab report as a technical report to a peer in class. Therefore, your audience is familiar with the lab materials; however, you need to explain the engineering and technical information as precisely as possible. The executive summary of your report should be able to be read by a professional audience such as industry partners, or other professors in the program.
Purpose of Lab Report: You are assigned to write a technical report on how your analytical analysis can be verified with the experimental results of the lab. Your report should include effective presentations of the lab data and thoughtful discussion based on the inspection, measurement, and test results. This lab requires conducting research with secondary sources (outside references available on the net and/or the library).
Required Lab Report Writing Style and Format: The technical reports are typically written using third-person perspective and past tense, and in many situations, an active voice provides better clarity and succinctness. One of the unique features of “technical reports” is a clear and easily accessible format. Technical reports need to be divided into sections that allow different readers to access different levels of information. Technical reports mostly consist of executive summary, introduction, methods, results, discussion, conclusion, and reference sections. Use the Metric System of units for this lab report.
Lab Report Submission: Please submit your completed lab report to the course website by the due date listed above. This allows you to have enough time to conduct data analysis and research with the secondary sources (references) as well as the primary sources (experimental data).

Sample 2: Lab Report (as a Research Paper) Writing Assignment

Assume you are an engineering intern working at the product design group of a company in the automotive industry, which may be similar to ABC Motors, City. Your boss, Ms. Boss, assigned you to conduct research on the mechanical properties and hardness of the materials used in a future project. Note that she is not asking you to pick the best material. All of these materials will be used for future vehicles because there are many parts and components. She will eventually share your report’s technical information with other engineers and/or people in the organization. For the project, three different material types such as 1018, 1045, and 4140 steels are considered. This means that you are assigned to write a lab report as a research paper primarily based on the testing results from the lab. This lab will provide you with the opportunities of reviewing knowledge on the mechanical properties and strengthening mechanisms of engineering materials (textbook chapters 6 and 7), conducting additional uniaxial tensile tests as well as hardness tests, conducting a comparative analysis with the obtained experimental data, and discussing the analysis with the outside sources or references in order to advance your knowledge.

In this experimental research paper, you can conduct a comparative study to compare three different steel samples in many different ways (e.g. 1018 vs 1045 to see the effect of carbon contents). In order to write a good research paper, you need to have good research questions to discuss. Your engineering team and organization might have the following questions:

Any technical questions from your own.
What would the effect of the carbon and/or alloying element contents have on the mechanical properties (strengths, ductility, etc) of the samples?
Does the fracture look ductile, brittle, or moderately ductile for each coupon?
Which sample does have the highest yield strength and/or UTS, ductility, toughness, hardness, etc. values? Why?
What are the average hardness and standard deviation values of each coupon? Is there a visible deviation in the measurement? What are the possible sources of errors?
Textbook page 179 shows the relationship between the tensile strength and the hardness values in HB for most steels. Is this formula accurate?

In order to write a good report or earn high scores, you do not need to answer all of these questions and/or come up with difficult-to-answer questions. A good lab report possesses well-defined questions and well-developed answers supported by both your experimental data (primary sources) and further research results using the internet or reference books (secondary sources). A good report has a well-defined introduction, body, and conclusion. In the introduction section, write about what you want to discover in the report. The objectives provide guidance on what you are going to say to your audience (your boss and engineering team in this case) throughout the report. In the body section, you summarize the experimental methods so the audience can confirm your testing was sound. You present the experimental data clearly and discuss them to follow your objectives. In the conclusion section, you need to summarize the main points of the lab along with a very brief restatement of the objectives and lab procedure.

Please submit your completed lab report in PDF on the course website by the due.

Sample 3: Lab Report (Memorandum or Letter as a Format) Writing Assignment:

Prepare a technical memorandum for your submission. The content of most memoranda to the technical audience can be organized into four main parts: heading, introduction, body (methods, results, discussion), conclusions, and closing. Depending on the intent and length of the memo, each part can be as short as a single phrase or as long as several paragraphs. Most memos are less than two pages. The following elements should be included

Letter/Memo Heading – TO: (readers’ names and job titles), FROM: (your name and job title), DATE: (complete and current date), SUBJECT: (subject of the lab).
Introduction – Objective and overview. Within the first two sentences, the purpose of the letter or memo is clearly stated. Provides background context for the discussion and educates the reader so they can understand the discussion.
Body – Methods, data presentation/analysis/interpretation. Include a brief description of the methodology, relevant findings, interpretation of data, and other significant items, including a brief explanation of significant errors.
Conclusions and Recommendations – Should recapitulate results and conclusions and recommend future work or action.
Courteous Closing (Includes your contact information).
References – Should be of sufficient quantity and quality, and cited properly within the text. Bibliographic information is included as a footnote.

Additional information to the written text is often required. Typical attachments include:

All figures and tables discussed in text, but self-explanatory.
Numbered and properly titled, contain units, and axis labels.
Referenced (if information not created by author).
Appropriate to communicate effectively.
Attachment 2* – Test Set-up: clear and self-explanatory, photos, sketches…
Attachment 3* – Data: self-explanatory data sheet; proper symbols and units.
Attachment 4* – Calculations: clear and self-explanatory, sources cited.
Additional attachments as required

Submit the lab report to your TA by the due.

Sample 4: A technical memo as a lab report (a technical memorandum) writing assignment

Structural Materials Supply, Inc.

3201 Campus Dr.

Klamath Falls, OR 97601

To:              Materials Testing Consultants

From:          MJ Johnson, Ph.D., P.E.

Date: June 24, 2022

Subject:        Creep deflection of bookshelves

Structural Materials Supply, Inc. is developing a line of bookshelves for use by prominent commercial office suppliers. Creep of bookshelves is a well-recognized problem across the industry. While we recognize that elastic deflections can be significant for heavily loaded shelves, we would like your help estimating the creep behavior of the Douglas-Fir beams we intend to use. Please help us determine a mathematical model of creep that can be used to predict long-term creep deflections so that we can further refine our product to meet long-term performance goals.

Specifically, we would like you to load a 1×6 Douglas Fir beam with enough weight to observe creep deflections. Please collect deflection versus time data, fit with an appropriate trendline, and predict long-term creep deflection at 100 years. Provide a description of creep behavior and let us know if we should be concerned about it in our products.

Please present your response in the form of a technical memorandum employing the IMRADC format. Submit this memo as a pdf along with a copy of the Excel file you developed to analyze the data.  Thank you in advance for your attention to detail and professional work.

PRO Courses Guides New Tech Help Pro Expert Videos About wikiHow Pro Upgrade Sign In
EDIT Edit this Article
EXPLORE Tech Help Pro About Us Random Article Quizzes Request a New Article Community Dashboard This Or That Game Popular Categories Arts and Entertainment Artwork Books Movies Computers and Electronics Computers Phone Skills Technology Hacks Health Men's Health Mental Health Women's Health Relationships Dating Love Relationship Issues Hobbies and Crafts Crafts Drawing Games Education & Communication Communication Skills Personal Development Studying Personal Care and Style Fashion Hair Care Personal Hygiene Youth Personal Care School Stuff Dating All Categories Arts and Entertainment Finance and Business Home and Garden Relationship Quizzes Cars & Other Vehicles Food and Entertaining Personal Care and Style Sports and Fitness Computers and Electronics Health Pets and Animals Travel Education & Communication Hobbies and Crafts Philosophy and Religion Work World Family Life Holidays and Traditions Relationships Youth
Browse Articles
Learn Something New
Quizzes Hot
This Or That Game New
Train Your Brain
Explore More
Support wikiHow
About wikiHow
Log in / Sign up
Education and Communications
Technical Writing

How to Write a Technical Report

Last Updated: September 28, 2023 Fact Checked

This article was co-authored by wikiHow staff writer, Christopher M. Osborne, PhD . Christopher Osborne has been a wikiHow Content Creator since 2015. He is also a historian who holds a PhD from The University of Notre Dame and has taught at universities in and around Pittsburgh, PA. His scholarly publications and presentations focus on his research interests in early American history, but Chris also enjoys the challenges and rewards of writing wikiHow articles on a wide range of subjects. There are 7 references cited in this article, which can be found at the bottom of the page. This article has been fact-checked, ensuring the accuracy of any cited facts and confirming the authority of its sources. This article has been viewed 83,406 times. Learn more...

Engineers, scientists, and medical professionals need to be good writers too—and technical reports prove it! A good technical report presents data and analysis on a specified topic in a clear, highly-organized, and effective manner. Before you begin writing, define your message and audience, and make an outline. Then, write the main body of the report and surround it with the other necessary sections, according to your chosen layout.

Technical Report Outline

Planning Your Report

Step 1 Establish the message you want to convey through the report.

For instance, you may want to convey the message that a new technique for extracting a particular chemical compound is both safer and more cost-effective.
The best technical reports remain clear and focused throughout—they have a specific purpose and convey the information in a logical order.
Work with advisors, supervisors, or colleagues to fine-tune the message and/or goal of your report. These can vary widely depending on whether the report is being produced for academic, business, or other purposes.

Step 2 Define your audience before you begin writing.

If others in your field will be reading the report, it can be more “technical” in language and detail. In many cases, though, technical reports are intended for those outside of your particular discipline. If so, cut back on the jargon for non-expert readers.
Consider having a non-expert friend look over your report throughout the process to give you feedback on its accessibility to a broad audience.

Step 3 Create an outline to follow while you write.

Determine which particular sections your report must or may have. Consult the person or organization to whom you’ll be submitting the report for any layout requirements.

Writing the Main Body of the Report

Step 1 Create a thorough but focused introduction to the report.

In most cases, the introduction will likely be 1-3 paragraphs in length.
The end of the introduction should clearly state what the report “does.” It might do so by way of a direct statement (“This report analyzes…”), or by providing a series of questions (which may in some cases be bulleted or numbered) to be addressed.

Step 2 Provide background information and/or a literature review in the next section.

Essentially, you want readers who may be new to the subject matter to feel like they have at least a rudimentary grasp of it after reading this section.

Step 3 Follow up with a clear and detailed project description.

If, for instance, your report is focused on a particular experiment, be specific on the way it was conceived, set up, and conducted.
This is sometimes called a “methods” section, since you are describing the methods used to conduct your research.

Step 4 Present your data and describe what it all means in the next sections.

It can be hard to determine how much data to present. Giving too little can significantly weaken your analysis and the overall report. Giving too much, however, can drown the reader in a sea of tables and figures. Make sure you provide all essential data, and err on the side of providing a bit too much unless otherwise instructed.
Present your data in a logical order, so that each table or figure leads into the next one.

Be as bold in your conclusions as your data and analysis permits you to be. Don’t use terms like “might,” “perhaps,” “could,” and so forth—write something like, “The data shows that…” However, don’t draw conclusions that aren’t supported by your data.

Adding Components in the Proper Layout

Step 1 Check for specific guidelines with your university, employer, etc.

Executive Summary
Table of Contents
List of Figures / List of Tables
Main Report: Introduction; Background / Literature Review; Project Description; Data / Description of Data; Conclusion
Acknowledgements

Step 2 Create a simple title page at the beginning of your report.

Write the abstract after you’ve written the actual report. You want it to be a condensed description of what you have written, not of what you intend to write.
Check to see if there is a specific word limit for your abstract. Even if there isn’t, 300 words is a good word limit to aim for.

Step 4 Create an executive summary that condenses the report by about 90%.

The executive summary should focus on your findings, conclusions, and/or recommendations, and allow the report itself to present the data—although highlights of the data should be provided.
Depending on your situation, you may need to write an abstract, an executive summary, or both.

Step 5 Draw up a table of contents, list of tables, and list of figures.

Check for any formatting guidelines for these sections. If the format is left up to you, keep things simple and straightforward.

Step 6 Follow the main body of the report with an acknowledgments section.

This section typically runs 1-2 paragraphs, and follows a fairly simple “The author would like to thank…” format.

Step 7 Include citations in the references section, using a consistent format.

In some cases, you may also be expected to provide a listing of works you have consulted but not specifically cited in the work. Check with the relevant department, organization, individual, etc., if you’re not sure. [13] X Research source

Use a consistent, easy-to-navigate format when creating appendices. They aren’t meant to be dumping grounds for random snippets of data or information.

Expert Q&A

About This Article

Send fan mail to authors

Reader Success Stories

Nov 2, 2019

Did this article help you?

Featured Articles

Watch Articles

Terms of Use
Privacy Policy
Do Not Sell or Share My Info
Not Selling Info

Don’t miss out! Sign up for

wikiHow’s newsletter

Sign Up for Mailing List
Search Search

Username or Email Address

Remember Me

Resources for Teachers: Creating Writing Assignments

This page contains four specific areas:

Creating Effective Assignments

Checking the assignment, sequencing writing assignments, selecting an effective writing assignment format.

Research has shown that the more detailed a writing assignment is, the better the student papers are in response to that assignment. Instructors can often help students write more effective papers by giving students written instructions about that assignment. Explicit descriptions of assignments on the syllabus or on an “assignment sheet” tend to produce the best results. These instructions might make explicit the process or steps necessary to complete the assignment. Assignment sheets should detail:

the kind of writing expected
the scope of acceptable subject matter
the length requirements
formatting requirements
documentation format
the amount and type of research expected (if any)
the writer’s role
deadlines for the first draft and its revision

Providing questions or needed data in the assignment helps students get started. For instance, some questions can suggest a mode of organization to the students. Other questions might suggest a procedure to follow. The questions posed should require that students assert a thesis.

The following areas should help you create effective writing assignments.

Examining your goals for the assignment

How exactly does this assignment fit with the objectives of your course?
Should this assignment relate only to the class and the texts for the class, or should it also relate to the world beyond the classroom?
What do you want the students to learn or experience from this writing assignment?
Should this assignment be an individual or a collaborative effort?
What do you want students to show you in this assignment? To demonstrate mastery of concepts or texts? To demonstrate logical and critical thinking? To develop an original idea? To learn and demonstrate the procedures, practices, and tools of your field of study?

Defining the writing task

Is the assignment sequenced so that students: (1) write a draft, (2) receive feedback (from you, fellow students, or staff members at the Writing and Communication Center), and (3) then revise it? Such a procedure has been proven to accomplish at least two goals: it improves the student’s writing and it discourages plagiarism.
Does the assignment include so many sub-questions that students will be confused about the major issue they should examine? Can you give more guidance about what the paper’s main focus should be? Can you reduce the number of sub-questions?
What is the purpose of the assignment (e.g., review knowledge already learned, find additional information, synthesize research, examine a new hypothesis)? Making the purpose(s) of the assignment explicit helps students write the kind of paper you want.
What is the required form (e.g., expository essay, lab report, memo, business report)?
What mode is required for the assignment (e.g., description, narration, analysis, persuasion, a combination of two or more of these)?

Defining the audience for the paper

Can you define a hypothetical audience to help students determine which concepts to define and explain? When students write only to the instructor, they may assume that little, if anything, requires explanation. Defining the whole class as the intended audience will clarify this issue for students.
What is the probable attitude of the intended readers toward the topic itself? Toward the student writer’s thesis? Toward the student writer?
What is the probable educational and economic background of the intended readers?

Defining the writer’s role

Can you make explicit what persona you wish the students to assume? For example, a very effective role for student writers is that of a “professional in training” who uses the assumptions, the perspective, and the conceptual tools of the discipline.

Defining your evaluative criteria

1. If possible, explain the relative weight in grading assigned to the quality of writing and the assignment’s content:

depth of coverage
organization
critical thinking
original thinking
use of research
logical demonstration
appropriate mode of structure and analysis (e.g., comparison, argument)
correct use of sources
grammar and mechanics
professional tone
correct use of course-specific concepts and terms.

Here’s a checklist for writing assignments:

Have you used explicit command words in your instructions (e.g., “compare and contrast” and “explain” are more explicit than “explore” or “consider”)? The more explicit the command words, the better chance the students will write the type of paper you wish.
Does the assignment suggest a topic, thesis, and format? Should it?
Have you told students the kind of audience they are addressing — the level of knowledge they can assume the readers have and your particular preferences (e.g., “avoid slang, use the first-person sparingly”)?
If the assignment has several stages of completion, have you made the various deadlines clear? Is your policy on due dates clear?
Have you presented the assignment in a manageable form? For instance, a 5-page assignment sheet for a 1-page paper may overwhelm students. Similarly, a 1-sentence assignment for a 25-page paper may offer insufficient guidance.

There are several benefits of sequencing writing assignments:

Sequencing provides a sense of coherence for the course.
This approach helps students see progress and purpose in their work rather than seeing the writing assignments as separate exercises.
It encourages complexity through sustained attention, revision, and consideration of multiple perspectives.
If you have only one large paper due near the end of the course, you might create a sequence of smaller assignments leading up to and providing a foundation for that larger paper (e.g., proposal of the topic, an annotated bibliography, a progress report, a summary of the paper’s key argument, a first draft of the paper itself). This approach allows you to give students guidance and also discourages plagiarism.
It mirrors the approach to written work in many professions.

The concept of sequencing writing assignments also allows for a wide range of options in creating the assignment. It is often beneficial to have students submit the components suggested below to your course’s STELLAR web site.

Use the writing process itself. In its simplest form, “sequencing an assignment” can mean establishing some sort of “official” check of the prewriting and drafting steps in the writing process. This step guarantees that students will not write the whole paper in one sitting and also gives students more time to let their ideas develop. This check might be something as informal as having students work on their prewriting or draft for a few minutes at the end of class. Or it might be something more formal such as collecting the prewriting and giving a few suggestions and comments.

Have students submit drafts. You might ask students to submit a first draft in order to receive your quick responses to its content, or have them submit written questions about the content and scope of their projects after they have completed their first draft.

Establish small groups. Set up small writing groups of three-five students from the class. Allow them to meet for a few minutes in class or have them arrange a meeting outside of class to comment constructively on each other’s drafts. The students do not need to be writing on the same topic.

Require consultations. Have students consult with someone in the Writing and Communication Center about their prewriting and/or drafts. The Center has yellow forms that we can give to students to inform you that such a visit was made.

Explore a subject in increasingly complex ways. A series of reading and writing assignments may be linked by the same subject matter or topic. Students encounter new perspectives and competing ideas with each new reading, and thus must evaluate and balance various views and adopt a position that considers the various points of view.

Change modes of discourse. In this approach, students’ assignments move from less complex to more complex modes of discourse (e.g., from expressive to analytic to argumentative; or from lab report to position paper to research article).

Change audiences. In this approach, students create drafts for different audiences, moving from personal to public (e.g., from self-reflection to an audience of peers to an audience of specialists). Each change would require different tasks and more extensive knowledge.

Change perspective through time. In this approach, students might write a statement of their understanding of a subject or issue at the beginning of a course and then return at the end of the semester to write an analysis of that original stance in the light of the experiences and knowledge gained in the course.

Use a natural sequence. A different approach to sequencing is to create a series of assignments culminating in a final writing project. In scientific and technical writing, for example, students could write a proposal requesting approval of a particular topic. The next assignment might be a progress report (or a series of progress reports), and the final assignment could be the report or document itself. For humanities and social science courses, students might write a proposal requesting approval of a particular topic, then hand in an annotated bibliography, and then a draft, and then the final version of the paper.

Have students submit sections. A variation of the previous approach is to have students submit various sections of their final document throughout the semester (e.g., their bibliography, review of the literature, methods section).

In addition to the standard essay and report formats, several other formats exist that might give students a different slant on the course material or allow them to use slightly different writing skills. Here are some suggestions:

Journals. Journals have become a popular format in recent years for courses that require some writing. In-class journal entries can spark discussions and reveal gaps in students’ understanding of the material. Having students write an in-class entry summarizing the material covered that day can aid the learning process and also reveal concepts that require more elaboration. Out-of-class entries involve short summaries or analyses of texts, or are a testing ground for ideas for student papers and reports. Although journals may seem to add a huge burden for instructors to correct, in fact many instructors either spot-check journals (looking at a few particular key entries) or grade them based on the number of entries completed. Journals are usually not graded for their prose style. STELLAR forums work well for out-of-class entries.

Letters. Students can define and defend a position on an issue in a letter written to someone in authority. They can also explain a concept or a process to someone in need of that particular information. They can write a letter to a friend explaining their concerns about an upcoming paper assignment or explaining their ideas for an upcoming paper assignment. If you wish to add a creative element to the writing assignment, you might have students adopt the persona of an important person discussed in your course (e.g., an historical figure) and write a letter explaining his/her actions, process, or theory to an interested person (e.g., “pretend that you are John Wilkes Booth and write a letter to the Congress justifying your assassination of Abraham Lincoln,” or “pretend you are Henry VIII writing to Thomas More explaining your break from the Catholic Church”).

Editorials . Students can define and defend a position on a controversial issue in the format of an editorial for the campus or local newspaper or for a national journal.

Cases . Students might create a case study particular to the course’s subject matter.

Position Papers . Students can define and defend a position, perhaps as a preliminary step in the creation of a formal research paper or essay.

Imitation of a Text . Students can create a new document “in the style of” a particular writer (e.g., “Create a government document the way Woody Allen might write it” or “Write your own ‘Modest Proposal’ about a modern issue”).

Instruction Manuals . Students write a step-by-step explanation of a process.

Dialogues . Students create a dialogue between two major figures studied in which they not only reveal those people’s theories or thoughts but also explore areas of possible disagreement (e.g., “Write a dialogue between Claude Monet and Jackson Pollock about the nature and uses of art”).

Collaborative projects . Students work together to create such works as reports, questions, and critiques.

Writing Technical Instructions

Resources & Preparation
Instructional Plan
Related Resources

Learning to write technical instructions is challenging. Writers must consider audience, purpose, context, length, and complexity—plus the specific content of the instructions, such as the steps in using a stapler. In this lesson, students walk through the process of creating technical instructions by first analyzing existing instructions. They then select an item and an audience for which they will write technical instructions. After writing their own instructions, students conduct usability tests of each other's instructions, providing user feedback. Finally, students use this user feedback to revise their instructions before publishing them.

Featured Resources

Analyzing Technical Instructions : Students can use the questions on this handout as a guide when they analyze sample technical instructions. Technical Instructions Planning Sheet : This handout explains the process for working with a partner to plan the technical instructions they will write. Conducting a Usability Test : This handout includes instructions for testing the technical instructions students have written.

From Theory to Practice

Teaching students how to write technical instructions helps them see that "to write, to engage in any communication, is to participate in a community; to write well is to understand the conditions of one's own participation-the concepts, values, traditions, and style which permit identification with that community and determine the success or failure of communication" (Miller 22). Similarly, in discussing finding meaningful writing activities for the English classroom, Weber writes: "The technical writing approach is one of many avenues to this goal. It engages my students in the total communications process: creating, planning, writing, editing, presenting, listening, sharing, and evaluating." Understanding discourse communities requires students to analyze the audience for a written work, and learning to write instructions is one such way students can learn about both audience analysis and technical writing. This lesson works toward building students' understanding of the importance their writing has on real audiences. Further Reading

Common Core Standards

This resource has been aligned to the Common Core State Standards for states in which they have been adopted. If a state does not appear in the drop-down, CCSS alignments are forthcoming.

State Standards

This lesson has been aligned to standards in the following states. If a state does not appear in the drop-down, standard alignments are not currently available for that state.

NCTE/IRA National Standards for the English Language Arts

1. Students read a wide range of print and nonprint texts to build an understanding of texts, of themselves, and of the cultures of the United States and the world; to acquire new information; to respond to the needs and demands of society and the workplace; and for personal fulfillment. Among these texts are fiction and nonfiction, classic and contemporary works.
4. Students adjust their use of spoken, written, and visual language (e.g., conventions, style, vocabulary) to communicate effectively with a variety of audiences and for different purposes.
5. Students employ a wide range of strategies as they write and use different writing process elements appropriately to communicate with different audiences for a variety of purposes.
6. Students apply knowledge of language structure, language conventions (e.g., spelling and punctuation), media techniques, figurative language, and genre to create, critique, and discuss print and nonprint texts.
8. Students use a variety of technological and information resources (e.g., libraries, databases, computer networks, video) to gather and synthesize information and to create and communicate knowledge.
9. Students develop an understanding of and respect for diversity in language use, patterns, and dialects across cultures, ethnic groups, geographic regions, and social roles.
11. Students participate as knowledgeable, reflective, creative, and critical members of a variety of literacy communities.
12. Students use spoken, written, and visual language to accomplish their own purposes (e.g., for learning, enjoyment, persuasion, and the exchange of information).

Materials and Technology

Sample technical instructions (Manuals, user guides, etc.)
Household items for writing instructions
Access to computer with Internet connection, Microsoft Word or Publisher, and printer
Large white paper (Chart-sized sticky notes work well for hanging items on wall)
Digital camera (optional)
Analyzing Technical Instructions
Sample Technical Instructions Rubric
Technical Instructions Planning Sheet
Visually Drafting Your Instructions
Using ReadWriteThink Notetaker to Draft Instructions
Conducting a Usability Test

Preparation

Collect a variety of written technical instructions for household items for students to use to analyze. Try to collect both effective and ineffective examples. Examples are also available online, at the Websites listed in the Resources section . Review the examples to familiarize yourself with their features and effectiveness.
Prepare three or four examples of effective and ineffective written technical instructions, using those you gathered or online examples, to be shown on an overhead or a document camera.
Make sure students have access to computer labs during sessions two through five.
Prepare copies of all handouts for distribution in class.
Test the Notetaker on your computers to familiarize yourself with the tool and ensure that you have the Flash plug-in installed. You can download the plug-in from the technical support page.

Student Objectives

Students will

analyze technical instructions to learn what makes them effective or ineffective for an audience.
analyze and describe the audience for a set of instructions, noting what that audience needs from that document.
understand the difference between technical writing and other genres of writing.
use document and audience analysis, drafting, peer response/user feedback, and revision to create effective technical instructions.
reflect on their writing process, noting how this assignment will be useful to them in future writing.

Session One

Ask students to talk about their experiences reading and using different types of written texts.
How are these different?
How do these genres speak to different audiences?
How do these types of writing work toward different purposes?
Ask students to focus on technical writing as a genre and to brainstorm the different kinds of written instructions they have seen or used in the past. Record their responses on the board or an overhead transparency.
What were they using the instructions for?
How helpful were they?
What were the best parts of the instructions?
What parts were difficult or hard to use?
What did they do if they had trouble using the instructions?
Arrange the class in groups of two to four students each, and give each group a set of instructions from those that you gathered. If the class meets in a computer classroom, share the links to instructions included in the Resources section.
Pass out copies of the Analyzing Technical Instructions , and ask students to analyze their instructions and record their observations on the handout.
When students complete their analysis, bring the class together and have each group report on their set of instructions.
On a sheet of chart paper, make a list of the top five effective and top five ineffective things students noticed about the instructions.
Hang this paper on the wall in the classroom for reference during the next three class sessions.
Ask students to bring one common household item to the next class session. Explain that students will write their own instructions for the item, so they should bring items that do not already have written instructions.
Brainstorm and discuss with students what would make good items and what would be too complex.
Encourage them to bring items that are not overly complex but not too simple either. Examples may include a stapler, clock, paper punch, flashlight, mechanical pencil, etc. Students should be able to write instructions for operating 2–3 features of the item. (For example, how to use a stapler and how to replace staples when cartridge is empty.) Encourage students to be creative in their choices.
Gather some extra items from the classroom or your home before the next session so you have options for students who forget to bring items.

Session Two

Review the top five effective and ineffective things about technical instructions from previous session with the class.
Spend more time with this topic, asking students to create a rubric determining what makes technical documents effective or ineffective. Use the Sample Technical Instructions Rubric as a model or starting point for the task.
Ask students to take out their household item, and spend five minutes freewriting about why they chose that item and how difficult it may or may not be to write instructions for it.
Arrange students in pairs, and ask them to share the item they brought and their thoughts from the freewriting.
Have students interview each other, using the Technical Instructions Planning Sheet to take notes about each other’s items.
Once interviews are complete, have students begin drafting their instructions. Give them large pieces of white paper for them to design, or mock up, their rough drafts.
Pass out copies or share an overhead transparency of the Visually Drafting Your Instructions sheet. Explain that students will draw separate boxes for each part of the item they want their instructions to cover, following the information on the handout.
Demonstrate how to use the ReadWriteThink Notetaker to document the steps in instructions, sharing the Using ReadWriteThink Notetaker to Draft Instructions handout with the class.
Have students use their notes on the Planning Sheet and their copies of the Visually Drafting Your Instructions handout to begin writing. Students can use the Notetaker to draft their instructions.
After students have outlined their instructions using Notetaker , ask them to print their work. Work cannot be saved in the Notetaker .
For homework, ask students to continue drafting their outlines using the Notetaker . Students should bring printed copies of Notetaker outlines to next session.

Session Three

Review outlines created using ReadWriteThink Notetaker with students.
Ask students to discuss how they will organize their notes into instructions, how many pages they will need, whether they need to include pictures to illustrate instructions.
The Process of Writing a Technical Manual
Instructions: How to Write for Busy, Grouchy People
After students review the site, ask them to write down three things they learned that they will consider as they write their own instructions.
Invite students to share their observations and discuss the advice as a whole class.
Review the expectations for the project using the rubric students created during the previous session. Answer any questions that students have about the project.
Explain the options that students have for creating polished drafts of their work. Point out the available software (e.g., Microsoft Word, Publisher) that students can use to type and format their instructions. (Depending on the class, instructors may need to instruct students on using the software to do this).
inserting Clip Art images.
drawing diagrams of their items using the computer or drawing by hand.
labeling parts or connecting the diagrams to the instructions.
importing images taken with a digital camera.
Ask students to print copies of their instructions when finished.
If additional time is needed, ask students to finish drafting their instructions for homework.
Remind students to bring a copy of their instructions and the related item to the next class.

Session Four

Students will bring a copy of their printed (complete) instructions and their household item.
Pass out copies of the instructions for Conducting a Usability Test and review the instructions with students.
Ask students to use the remaining class time to conduct at least two usability tests. Ensure that students understand that two different students will read and test their instructions for using the household item.
If time allows, students can begin revising their instructions in class and consult with the testers as appropriate.
For homework, students can continue working on revising their instructions. Students will finish revisions during the next session and submit their work.

Session Five

Have students revise their instructions, using the available resources—word processing software, clip art, and so forth.
Encourage students to consult the notes from their usability testing as they revise.
As students revise, circulate through the room, meeting with student to discuss revisions and offer suggestions.
Ask students to print their technical instructions, staple or attach pages as needed, and present final products to the class or school by the end of the session.
Spend additional time exploring document design by exploring alternative publishing options such as pamphlets, brochures, and different-sized documents.
Rather than writing instructions for operating a common household item, ask students to write instructions for completing a basic task, such as making a sandwich or addressing an envelope.
For a humorous break, share this Wendy’s training video and ask students to discuss what was effective and ineffective about those instructions. Be sure to discuss when the video was produced and how the video fit (or didn’t) the needs of the audience at the time it was produced.

Student Assessment / Reflections

Collect students’ worksheets, including the Analyzing Technical Instructions and the Technical Instructions Planning Sheet , and the notes taken during the Usability Test . Review the work for completion and understanding of the basic goals of the lesson, including comprehension of the role that audience and purpose play in effective technical writing.
During class discussion and students’ work in pairs, listen for comments that show students can think critically about the goals and effective strategies for technical writing in general and specifically for instructions.
For a formal assessment, use the rubric created by the class during Session Two, which was based on the the Sample Technical Instructions Rubric .
Student Interactives
Lesson Plans

Useful for a wide variety of reading and writing activities, this outlining tool allows students to organize up to five levels of information.

Print this resource

Explore Resources by Grade

Kindergarten K

Purdue Online Writing Lab Purdue OWL® College of Liberal Arts

Understanding Writing Assignments

Welcome to the Purdue OWL

This page is brought to you by the OWL at Purdue University. When printing this page, you must include the entire legal notice.

Copyright ©1995-2018 by The Writing Lab & The OWL at Purdue and Purdue University. All rights reserved. This material may not be published, reproduced, broadcast, rewritten, or redistributed without permission. Use of this site constitutes acceptance of our terms and conditions of fair use.

How to Decipher the Paper Assignment

Many instructors write their assignment prompts differently. By following a few steps, you can better understand the requirements for the assignment. The best way, as always, is to ask the instructor about anything confusing.

Read the prompt the entire way through once. This gives you an overall view of what is going on.
Underline or circle the portions that you absolutely must know. This information may include due date, research (source) requirements, page length, and format (MLA, APA, CMS).
Underline or circle important phrases. You should know your instructor at least a little by now - what phrases do they use in class? Does he repeatedly say a specific word? If these are in the prompt, you know the instructor wants you to use them in the assignment.
Think about how you will address the prompt. The prompt contains clues on how to write the assignment. Your instructor will often describe the ideas they want discussed either in questions, in bullet points, or in the text of the prompt. Think about each of these sentences and number them so that you can write a paragraph or section of your essay on that portion if necessary.
Rank ideas in descending order, from most important to least important. Instructors may include more questions or talking points than you can cover in your assignment, so rank them in the order you think is more important. One area of the prompt may be more interesting to you than another.
Ask your instructor questions if you have any.

After you are finished with these steps, ask yourself the following:

What is the purpose of this assignment? Is my purpose to provide information without forming an argument, to construct an argument based on research, or analyze a poem and discuss its imagery?
Who is my audience? Is my instructor my only audience? Who else might read this? Will it be posted online? What are my readers' needs and expectations?
What resources do I need to begin work? Do I need to conduct literature (hermeneutic or historical) research, or do I need to review important literature on the topic and then conduct empirical research, such as a survey or an observation? How many sources are required?
Who - beyond my instructor - can I contact to help me if I have questions? Do you have a writing lab or student service center that offers tutorials in writing?

(Notes on prompts made in blue )

Poster or Song Analysis: Poster or Song? Poster!

Goals : To systematically consider the rhetorical choices made in either a poster or a song. She says that all the time.

Things to Consider: ah- talking points

how the poster addresses its audience and is affected by context I'll do this first - 1.
general layout, use of color, contours of light and shade, etc.
use of contrast, alignment, repetition, and proximity C.A.R.P. They say that, too. I'll do this third - 3.
the point of view the viewer is invited to take, poses of figures in the poster, etc. any text that may be present
possible cultural ramifications or social issues that have bearing I'll cover this second - 2.
ethical implications
how the poster affects us emotionally, or what mood it evokes
the poster's implicit argument and its effectiveness said that was important in class, so I'll discuss this last - 4.
how the song addresses its audience
lyrics: how they rhyme, repeat, what they say
use of music, tempo, different instruments
possible cultural ramifications or social issues that have bearing
emotional effects
the implicit argument and its effectiveness

These thinking points are not a step-by-step guideline on how to write your paper; instead, they are various means through which you can approach the subject. I do expect to see at least a few of them addressed, and there are other aspects that may be pertinent to your choice that have not been included in these lists. You will want to find a central idea and base your argument around that. Additionally, you must include a copy of the poster or song that you are working with. Really important!

I will be your audience. This is a formal paper, and you should use academic conventions throughout.

Length: 4 pages Format: Typed, double-spaced, 10-12 point Times New Roman, 1 inch margins I need to remember the format stuff. I messed this up last time =(

Academic Argument Essay

5-7 pages, Times New Roman 12 pt. font, 1 inch margins.

Minimum of five cited sources: 3 must be from academic journals or books

Design Plan due: Thurs. 10/19
Rough Draft due: Monday 10/30
Final Draft due: Thurs. 11/9

Remember this! I missed the deadline last time

The design plan is simply a statement of purpose, as described on pages 40-41 of the book, and an outline. The outline may be formal, as we discussed in class, or a printout of an Open Mind project. It must be a minimum of 1 page typed information, plus 1 page outline.

This project is an expansion of your opinion editorial. While you should avoid repeating any of your exact phrases from Project 2, you may reuse some of the same ideas. Your topic should be similar. You must use research to support your position, and you must also demonstrate a fairly thorough knowledge of any opposing position(s). 2 things to do - my position and the opposite.

Your essay should begin with an introduction that encapsulates your topic and indicates 1 the general trajectory of your argument. You need to have a discernable thesis that appears early in your paper. Your conclusion should restate the thesis in different words, 2 and then draw some additional meaningful analysis out of the developments of your argument. Think of this as a "so what" factor. What are some implications for the future, relating to your topic? What does all this (what you have argued) mean for society, or for the section of it to which your argument pertains? A good conclusion moves outside the topic in the paper and deals with a larger issue.

You should spend at least one paragraph acknowledging and describing the opposing position in a manner that is respectful and honestly representative of the opposition’s 3 views. The counterargument does not need to occur in a certain area, but generally begins or ends your argument. Asserting and attempting to prove each aspect of your argument’s structure should comprise the majority of your paper. Ask yourself what your argument assumes and what must be proven in order to validate your claims. Then go step-by-step, paragraph-by-paragraph, addressing each facet of your position. Most important part!

Finally, pay attention to readability . Just because this is a research paper does not mean that it has to be boring. Use examples and allow your opinion to show through word choice and tone. Proofread before you turn in the paper. Your audience is generally the academic community and specifically me, as a representative of that community. Ok, They want this to be easy to read, to contain examples I find, and they want it to be grammatically correct. I can visit the tutoring center if I get stuck, or I can email the OWL Email Tutors short questions if I have any more problems.

Company Overview
Client Wins
Proposal Center
Proposal Development
Market Assessment
Business Development
Capture Management
Orals Coaching
Graphic Design & Desktop Publishing

Key Solutions Blog

A guide to writing a technical approach.

Jul 28, 2022

Let's set the scene. You’ve just come on to a new proposal effort and are anxiously awaiting your writing assignment.

When it finally hits your inbox, fear rises as you discover that you have been assigned the Technical Approach and have no technical expertise. Do not panic! We’ve got your back! Keep reading for some proven do’s and don'ts to help you write a winning Technical Approach.

What the Technical Approach should be

The Technical Approach should meet the customer’s technical requirements, clearly show your methodologies and solutions for doing this work, and include impactful proof points to validate your claims and reinforce your success. While responding to the technical requirements of the RFP is critical, ensuring that the other sections of the proposal, such as Program Management, Staffing, Transition, and Pricing support the Technical Approach provides a truly powerful, compelling case to the customer. The government will evaluate the degree to which your proposal submission presents a clear understanding of the work statement in the request. Remember, proposals are scored, not read. It is important to note that the RFP usually specifies the relative weightings of the Technical, Management, Transition, Price, and other sections. Oftentimes, we see general information used to address a project’s Technical Approach section. This approach is a big mistake that will cost you dearly at scoring. A comprehensive, clear Technical Approach is essential to your proposal's success, but often, the development of the Technical Approach lags the rest of the proposal.

Because of space constraints, a lack of time and understanding, or poor planning, offerors often fill the Technical Approach section of a proposal response with reuse or boilerplate material instead of a customized, scope-specific solution. Such shortcuts result in a missed opportunity to highlight and weave in key win themes and discriminators of your proposed work plan.

The goal of a Technical Approach document is twofold:

To demonstrate that your solution is fully compliant.
To supply a solution that is compelling in meeting the customer’s requirements better and as a better value than any alternative.

Writers should remember that the focus of a Technical Approach should be on how the customer will benefit from what you offer. Evaluators should walk away understanding why your proposal is their obvious best option. The section should demonstrate your understanding of the requirements and the approach to satisfying them.

There are many ways to approach writing technical sections. The KSI Advantage™ process recommends the following steps:

Recommended Steps for Writing Technical Approach

Describe the Technical Challenge(s). What is the problem in need of a solution? What are the risks? What are the consequences of failure to fix the problem? Demonstrate you understand the scope and complexity of the problem. Describe the as-is state and why it is not optimal or could be improved.
List Your Assumptions. What reasonable, necessary, or desirable assumptions must be made to support the plan?
Who: Organization or key personnel, responsibilities, and authorities, labor categories, skill mix
What: System, technology, process, procedure, policy, steps, activities
When: Timeframe, schedule, milestones, dates, phases
Where: Location(s) where the work will be performed
Why: Rationale for why your solution will work
How: Methods to measure your solution’s effectiveness, including metrics, performance measures, success criteria, and relevant benchmarks; identify potential risks of your plan, and eliminate or mitigate them
Provide Your Experience. Provide your relevant experience and past performance that demonstrates the credibility and effectiveness of your approach. Include examples of past performance handling contracts of similar scale, scope, and complexity. Provide metrics of your success where appropriate.
Articulate the Customer Benefits. How will your customer benefit from your understanding, plan, and relevant experience? Be specific. Think improved safety, enhanced quality, improved performance, reduced costs, accelerated schedule, reduced risk, and increased customer or stakeholder satisfaction.
Define the Vision for the End State. Assume your solution was successfully implemented. What is the end state? What would it look like? Describe how activities would be carried out safer, better, faster, and cheaper.
Support with Graphics. Technical processes are difficult to describe in words. Include supporting graphics, such as process flows, charts, milestone schedules, matrices, risk registers, schematics, pictures, customer testimonials, snapshots of awards or commendations, feature/benefit charts, organizational charts, or related visuals. Below is an example of Feature and Benefits Table that applies to a technical section.

Helpful tips when developing the Technical Approach

Read it ALL: Make sure you read the entire solicitation carefully and understand all the requirements while identifying anything that is not clear and needs clarification by the Government or that will require a corporate decision on how to respond. If the specifications are unclear or contradictory, consider submitting a Request for Information (RFI) to ensure you have all the information for a clear understanding.
Follow the RFP and Evaluate the Rating Scheme: Use the order of the RFP to develop your outline and systematically address all submission and evaluation criteria. Make sure you understand the implications of the rating scale.
Remain Customer Focused: This entire process is about them, not you. Emphasize why they should pick your proposal over every other submission by showing how your approach will benefit them.
Include a Corporate Blue Team Review: A corporate review of the proposed technical solution ensures the right questions are asked early in the development process and avoids lagging or misalignment with the Management, Pricing, and Transition sections.
Work with Subject-Matter Expert(s) (SMEs): Before you can write to a solution, you must understand it. SMEs hold the keys to that understanding. Engage a SME to ensure a thorough approach is provided for critical scope areas. Expert knowledge will go a long way in showing your understanding of the project.
Include Opportunity-Specific Details: Do not just restate the SOW/PWS. The Technical Approach is your opportunity to provide details! Stand out from the competition by demonstrating your understanding of the project through a work breakdown structure or thoughtful sequencing information.
Connect to the Schedule: If a schedule is required, make sure the narrative matches, and ensure the Technical Approach is reflected in the Transition Plan. Check for consistency across key elements such as start dates, dates for full operation, total contract duration, etc.
Ensure the Staffing Plan Includes Required or Key Personnel : You can’t do the work if you don’t have the staff. Make sure technical staff are in place to execute the technical work and that all necessary staff have been considered in the overall Staffing Plan of the proposal. Be sure staff covers all the positions, skills, and qualifications the client specifies.
Identify Risks and Mitigation Plans: Every project has its challenges as well as its opportunities. Make sure to identify any major technical risks and provide a brief description of your mitigation strategy.
Ensure Compliance: Review your content and make sure that your proposal appropriately addresses all of the RFP specifications, is formatted as requested, and includes all of the required forms for a fully compliant response.
Be Consistent: Make sure you have double and triple-checked your grammar, titles, acronyms, key personnel, meeting names, format, etc. for consistency throughout the entire proposal.
Simulate a Review: Mimic a source-selection committee by having a separate person or group that is not involved in the preparation of the approach to review your proposal. As every writer knows, a fresh pair of eyes can see things we cannot. They may be able to identify a deficiency that needs additional language to get the point across.
Make Sure the Management Approach Supports the Execution of the Technical Approach: Demonstrate the Management Approach you have designed to successfully execute your Technical Approach. Develop a high-level Program Management Plan and drill down to specific tasks, timelines, and deliverables. It must be clear to the evaluator that you have the appropriate personnel, oversight, and expertise needed to drive your Technical Approach.

Things to avoid

Now that we have spent significant time telling you what to do, here are some key “not to do’s.”

Don’t ignore the SOW/PWS and technical requirements.
Don’t wait to engage your technical SMEs.
Don’t skimp on the details that give your proposal strength and proof points.
Don’t forget that you need an appropriate Staffing Plan to do the work.
Don’t price yourself so high that it does not match the weight of your Technical Approach.
Don’t fill your Technical Approach with fluffy, non-specific language.

If you are assigned the Technical Approach section of a proposal, do not fret! Remember it is crucial to present a fact-based approach that demonstrates a clear, tangible value to the customer.

Your response should illustrate how you will approach the project and meet the requirements in the solicitation while remaining customer-focused and integrating illustrative proof points throughout. Make sure you show them your value-add through metrics and thoughtful graphics. And don’t forget, proposals are scored, not read, so review your work like an evaluator would.

Topics: Proposal Writing KSI Advantage Capture & Proposal Guide Technical Solution KSI Advantage Technical Approach

Written by Melissa Serna

Melissa Serna is a Proposal Development Consultant with Key Solutions. She is an alumnus of Florida International University where she earned a BS in Mass Communication with a concentration in Journalism. Melissa then went on to complete an MS in Higher Education Administration at the University of Miami. She has extensive writing and editing experience and in her free time enjoys yoga, cooking, and traveling.

Beyond Compliance: How to Craft Compelling, Easy-to-Evaluate Resumes

Don’t Make Me Think: 5 Ways to Improve Proposal Readability

Posts by Topic

Key Solutions, Inc. (KSI) is a consulting firm that helps companies win government contracts through bid and proposal development services.

Learn More [fa icon="long-arrow-right"]

Useful Links

[fa icon="phone"] (703) 953-3838

[fa icon="envelope"] [email protected]

[fa icon="home"] 14420 Albemarle Point Place, Suite 200, Chantilly Virginia

[fa icon="linkedin-square"] [fa icon="twitter-square"]

[fa icon="facebook-square"].

Digital Offerings
Biochemistry
College Success
Communication
Electrical Engineering
Environmental Science
Mathematics
Nutrition and Health
Philosophy and Religion
Our Mission
Our Leadership
Accessibility
Diversity, Equity, Inclusion
Learning Science
Sustainability
Affordable Solutions
Curriculum Solutions
Inclusive Access
Lab Solutions
LMS Integration
Instructor Resources
iClicker and Your Content
Badging and Credidation
Press Release
Learning Stories Blog
Discussions
The Discussion Board
Webinars on Demand
Digital Community
Macmillan Learning Peer Consultants
Macmillan Learning Digital Blog
Learning Science Research
Macmillan Learning Peer Consultant Forum
The Institute at Macmillan Learning
Professional Development Blog
Teaching With Generative AI: A Course for Educators
English Community
Achieve Adopters Forum
Hub Adopters Group
Psychology Community
Psychology Blog
Talk Psych Blog
History Community
History Blog
Communication Community
Communication Blog
College Success Community
College Success Blog
Economics Community
Economics Blog
Institutional Solutions Community
Institutional Solutions Blog
Handbook for iClicker Administrators
Nutrition Community
Nutrition Blog
Lab Solutions Community
Lab Solutions Blog
STEM Community
STEM Achieve Adopters Forum
Contact Us & FAQs
Find Your Rep
Training & Demos
First Day of Class
For Booksellers
International Translation Rights
Permissions
Report Piracy

Digital Products

Instructor catalog, our solutions.

Macmillan Community

A Short Proposal Assignment Idea

Subscribe to RSS Feed
Mark as New
Mark as Read
Printer Friendly Page
Report Inappropriate Content
Composition
Developmental English
assignments: english
professional communication
technical writing
workplace writing

You must be a registered user to add a comment. If you've already registered, sign in. Otherwise, register and sign in.

Bedford New Scholars 49
Composition 554
Corequisite Composition 58
Developmental English 38
Events and Conferences 6
Instructor Resources 9
Literature 55
Professional Resources 4
Virtual Learning Resources 48

How to Write A Technical Essay

Thornie longmuir.

April 5, 2022

Unlike personal or explanatory essays, technical essays are designed to inform about a technical topic. Such papers tend to have a more regulated format than other papers. Thus, writing requires a sense of organization.

Purpose of the essay

You need to study a technical subject and explain how to accomplish a specific technical assignment or to argue for a specific method of doing something. Essays are written for such disciplines as computer science, math, physics, and other technical subjects.

As you can see, writing a technical essay may not be easy, especially if you have this task for the first time. If you face some problems, you can get help from services like getcodinghelp.com . There, you can find an expert who understands your topic. Such help is also suitable for those who cannot complete the task on time.

Essay format

Technical essays have the same format as a research or other scientific paper. However, you need to find out if there are any special formatting requirements for your paper. You may need, for example, to use a specific font or align paragraphs to the left of the page without indents. You need to check whether your essay should be written in MLA , APA , or Chicago format style. In the academic sphere, not following the required style can lead to a low grade; in the business sphere, poor formatting can make you an amateur.

Structure of a technical essay

Start with a heading that describes the question you want to answer or the methods you are about to describe. Then write an abstract section detailing your question or method, your research process, and your conclusion, all in a short paragraph of several sentences. After that, create headings for the introduction, main body, and conclusion.

Writing essay sections

In the introduction of your technical essay, describe why you chose to explore this topic and why it is of value to your readers. Then provide a description of what you intend to research in the following paragraphs, and then dive into the details of your research in the main body. If you have conducted multiple experiments or explored multiple questions in your research, use this section and write subheadings describing what you are going to talk about in this particular subsection. In the conclusion, describe how you have achieved the result of the research process. At the very end, include the section with used sources.

Recommendations for writing an IT essay

By creating this essay, students demonstrate the skills of independent search and analytical work, immerse themselves in the topic, and try to find a solution to a specific problem that is embedded in the topic of the paper. But not all students know how to write an essay in IT. There are certain recommendations following which you can write a high-quality, informative, meaningful paper.

6. Stages of writing an essay on IT

An essay on IT is a scientific work; therefore, it should be approached responsibly and with complete seriousness. When writing it, the student reviews existing sources of literature and supplements the material with his or her own conclusions.

Let’s consider in stages how writing an essay looks and what needs to be taken into account.

Choosing a topic for the technical essay

As a rule, university teachers offer students a list of topics to choose from. When the topic is chosen, it is approved by the teacher. Alternatively, you can offer your ideas, but it should be borne in mind that the topic should be relevant and correspond to the content of the IT discipline.

Collect and analyze the material for the technical essay

This stage allows you to find information on the selected topic presented in different sources. Libraries, textbooks, the Internet – there is a lot of material here. If you have difficulties with the search, it is recommended to contact the teacher who will tell you where and in what sources you can find relevant information.

Think over the structure of the essay

There is no need to come up with something new since there are certain rules for the format and content of scientific works, and an essay on IT is no exception. It consists of:

Introduction
The main body – sections, subsections, paragraphs
List of used literature

Difficulties can arise when writing the main part of the text. Here, it is necessary to reveal the topic as much as possible, study the problem, and find a solution independently or based on information from other sources. If the student performs any calculations or creates tables or graphs, then they should be attached at the end of the essay. It is also important to adhere to the length recommended by the teacher.

7. Common mistakes

The text compiled purely on the basis of the author’s own thoughts, without using sources on the topic of the paper. The author is recommended to competently alternate personal thoughts with the studied information – this is how the objectivity of the presented data is achieved.
A bias towards presenting your own thoughts with a focus on the points of interest to you. This approach reduces the quality of the essay.
Lack of understanding of the essence of the problem posed with a lack of coherent text. A good technical essay is a detailed, comprehensive study of a topic. Such a paper is interesting to readers and valuable as scientific material.
Enumeration of outside thoughts, and the lack of the author’s position. Such an essay is not suitable, because without the author’s opinions it is not unique, but looks like a collection of other people’s ideas, developments, etc.

When it comes to writing technical essays, some students don’t know how to adjust. For this reason, we have presented this guide. You will succeed in writing if you follow our recommendations. Good luck!

tech in education

IT Chronicles

Advertise with Us
Write for Us
Our Contributors
Privacy Policy

Top Categories

Make a Gift
Directories

Search form

You are here.

Autumn 2024

ENGL 108 A: Writing Ready: Preparing for College Writing

Instagram
Newsletter

Study Guides
Homework Questions

LES 1015 - Writing Assignment 6 worksheet

IMAGES

33 Good Technical Writing Examples (Word & PDF) ᐅ TemplateLab
33 Good Technical Writing Examples (Word & PDF) ᐅ TemplateLab
How To Write A Technical Paper
FREE 10+ Sample Technical Proposals in PDF
33 Good Technical Writing Examples (Word & PDF) ᐅ TemplateLab
50 Professional Technical Report Examples (+Format Samples) ᐅ

VIDEO

A session on how to write technical paper by Dr. R.M. Kulkarni
How to write Technical Paper Part 1
How to Write Technical Documentation as a Technical Writer
How I Write Technical Writing Part 3
How I Write Technical Writing Part 2
Technical writing style guide (lecture 5 and 6)

COMMENTS

8 Technical Writing Examples to Inspire You
The different types of technical writing have unique characteristics that you can easily learn and master effectively. 1. User Manuals. User manuals or instruction manuals come with various products, such as consumer electronics like televisions, consoles, cellphones, kitchen appliances, and more.
Writing Instructions
Writing Instructions. One of the most common and important uses of technical writing is instructions—those step-by-step explanations of how to do things: assemble something, operate something, repair something, or explain a personal process (enrolling in college, for example) so that readers may better understand it and possibly use it ...
Understanding Technical Assignments: A Complete Guide
Mar 15, 2024. technical assignments help. In the realm of academia, technical assignments stand as formidable tests of students' knowledge and skills. From Mathematics to Engineering, these ...
Understanding Assignment Expectations
Chapter Overview. To craft a well-written technical document, you must first understand expectations for the piece in terms of purpose, audience, genre, writing style, content, design, referencing style, and so forth. This same truth applies to an academic assignment: you will be able to proceed with your writing task in a more straightforward ...
Technical Writing 101: What is it and How to Get Started
Practice writing about different topics and in different formats. Get Feedback: Don't be afraid to have others review your work. Constructive criticism can help you identify areas for improvement. Stay Organized: Good technical writing is clear and easy to follow. Make sure your writing is well-structured and logical.
Technical Writing for Beginners
Technical writing is the art of providing detail-oriented instruction to help users understand a specific skill or product. And a technical writer is someone who writes these instructions, otherwise known as technical documentation or tutorials. This could include user manuals, online support articles, or internal docs for coders/API developers ...
16 Technical Writing Prompts for Students » JournalBuddies.com
3. Keep Your Writing "Evergreen". It's typically also important to make sure that technical writing is as timeless as possible. Many technical documents are not updated very frequently—and those that are updated tend to only have small edits made (rather than the entire thing being rewritten).
7.7 Writing Instructions
7.7 Writing Instructions. One of the most common and important uses of technical writing is to provide instructions, those step-by-step explanations of how to assemble, operate, repair, or do routine maintenance on something. Although they may seems intuitive and simple to write, instructions are some of the worst-written documents you can find.
7 best technical writing examples to improve your skills
The Slack Help Center is an excellent example of technical writing that speaks to the layman. Slack is known for its brilliant UX copywriting. Amruta Ranade, Staff Technical Writer for Airbyte, admires the company's documentation writing style. She says, "Slack's Help Center shows incredible user-awareness.
Understanding Assignments
What this handout is about. The first step in any successful college writing venture is reading the assignment. While this sounds like a simple task, it can be a tough one. This handout will help you unravel your assignment and begin to craft an effective response. Much of the following advice will involve translating typical assignment terms ...
How to Set Expectations for Technical Writing Assignments
This resource discusses how to set expectations for technical writing and provides PowerPoint slides as an example of a lecture that can be adapted to meet the specific needs of any technical writing assignment. Why clarify expectations explicitly? Students have varied experiences in writing from high school and university. ...
CH 7 Assignment: Instructions
The main purpose of this assignment is to give you practice in writing instructions, one of the most common types of workplace technical writing. Whether working with office staff, technicians, managers, or executives, technical communicators are frequently called upon to write instructions, such as specific office procedures, training manuals ...
5. Proposals
Special Assignment Requirements. Remember that, in a technical writing course, the proposal assignment serves several purposes: (1) to give you some experience writing a proposal; (2) to get you started planning your major paper for the course; (3) to give your instructor a chance to work with you on your report project to ensure you've got ...
How to Write a Perfect Assignment: Step-By-Step Guide
To construct an assignment structure, use outlines. These are pieces of text that relate to your topic. It can be ideas, quotes, all your thoughts, or disparate arguments. Type in everything that you think about. Separate thoughts scattered across the sheets of Word will help in the next step. Then it is time to form the text.
CH 7 Assignment: Technical Descriptions
For this assignment, your task is to write a technical description of an item, including what it is, what it does, and how it works. Step 1: Choose an item that performs a task. Choose something that provides a challenge but is also manageable. Some examples include: a flash drive, a lawn mower engine, an air-impact wrench, an app or operating ...
How to Write Technical Guides
1. SEO (Search Engine Optimization) The first reason for writing technical guides is shared among many different types of articles, and it is, of course, SEO. By writing technical guides, you have the opportunity to include specific keywords, which can be a great way of getting ranked higher on search engines like Google.
Assignment Design
Sample 1: Lab Report (as a Technical Report) Writing Assignment. Overview: You (the writer of the report), a 2nd year engineering student, are assigned to write a technical report (the genre) to convey engineering and technical information, including the lab background, process, data, analysis results, and conclusion (the purpose of the report), to the instructor, the TA, and the peers (the ...
Simple Ways to Write a Technical Report (with Pictures)
5. Round out the report with a conclusion that bookends your introduction. In a technical report, your introduction should raise the "big" questions and your conclusion should provide your answers. If, for instance, you listed several specific questions in your intro, answer them specifically in the conclusion.
Resources for Teachers: Creating Writing Assignments
In scientific and technical writing, for example, students could write a proposal requesting approval of a particular topic. The next assignment might be a progress report (or a series of progress reports), and the final assignment could be the report or document itself. ... If you wish to add a creative element to the writing assignment, you ...
Writing Technical Instructions
Learning to write technical instructions is challenging. Writers must consider audience, purpose, context, length, and complexity—plus the specific content of the instructions, such as the steps in using a stapler. In this lesson, students walk through the process of creating technical instructions by first analyzing existing instructions.
Understanding Writing Assignments
Many instructors write their assignment prompts differently. By following a few steps, you can better understand the requirements for the assignment. The best way, as always, is to ask the instructor about anything confusing. Read the prompt the entire way through once. This gives you an overall view of what is going on.
A Guide to Writing a Technical Approach
The goal of a Technical Approach document is twofold: To demonstrate that your solution is fully compliant. To supply a solution that is compelling in meeting the customer's requirements better and as a better value than any alternative. Writers should remember that the focus of a Technical Approach should be on how the customer will benefit ...
A Short Proposal Assignment
The Project Assignment. Step 1: Decide on the focus for your white paper and poster presentation (which you will write as future projects). Your focus will be to inform non-expert readers about a technical topic that is related to your company (and therefore, related to your career field and major).
How to Write A Technical Essay
Structure of a technical essay. Start with a heading that describes the question you want to answer or the methods you are about to describe. Then write an abstract section detailing your question or method, your research process, and your conclusion, all in a short paragraph of several sentences.
ENGL 108 A: Writing Ready: Preparing for College Writing
Builds writing confidence through frequent informal writing, and introductions to key learning strategies. Includes user-friendly orientation to library and research documents, revision skills, and peer review work central to 100- and 200-level college writing assignments. Offered: A.
LES 1015
Subscribe to unlock this document and more. CliffsNotes study guides are written by real teachers and professors, so no matter what you're studying, CliffsNotes can ease your homework headaches and help you score high on exams. Accounting document from St. John's University, 2 pages, LES 1015 - Writing Assignment 6 worksheet Professor Yamen 1.
How teachers started using ChatGPT to grade assignments
A new tool called Writable, which uses ChatGPT to help grade student writing assignments, is being offered widely to teachers in grades 3-12. Why it matters: Teachers have quietly used ChatGPT to grade papers since it first came out — but now schools are sanctioning and encouraging its use. Driving the news: Writable, which is billed as a ...

RELATED TOPICS

8 Technical Writing Examples to Inspire You

TABLE OF CONTENTS

What Exactly is Technical Writing?

8 Technical Writing Examples to Get You Started

1. User Manuals

2. Standard Operating Procedures (SOP)

3. Case Studies & White Papers

4. API Documentation

5. Press Releases

6. Company Documents

7. Annual Reports

8. Business Plans

Becoming an Expert Technical Writer

Join 5000+ Technical Writers

Understanding Assignment Expectations

What positive aspects of your past assignments do you want to demonstrate in your next assignment?

Book Selection Email

Active voice explained

Passive voice explained

When to choose passive voice

Converting passive voice to active voice

Share This Book

Technical Writing 101: What is it and How to Get Started

Unpacking the Concept of Technical Writing

Importance of Technical Writing in Today’s Digital Age

Skills Required for Effective Technical Writing

Written Communication Skills

Understanding of Technical Concepts

Tools Used by Technical Writers

Steps to Becoming a Technical Writer

Tips for Improving Your Technical Writing Skills

The Role of a Technical Writer in Project Management

Future Trends in Technical Writing

Related posts:

Get Organized & Win More Clients

Technical Writing for Beginners – An A-Z Guide to Tech Blogging Basics

Table of Contents

Benefits of Technical Writing

The Technical Writing Process

Technical Writing Courses

What is Technical Writing?

Necessary Skills to Have as a Technical Writer

Know how to explain things clearly and simply

Possess some writing skills‌‌

Analyze and Understand who your Readers are

Think About User Experience

Plan Your Document

Conduct thorough research about the topic

Make an outline

Get relevant graphics/images

Write in the Correct Style

Use Active Voice

Choose Your Words Carefully

Avoid Excessive Jargon

Use Plain Language

Visual Formatting

Do a Careful Review

Where to Publish Your Articles

Technical Writing Forums and Communities

Some Amazing Technical Writers to follow

Final words

7.7 Writing Instructions

Preliminary Steps

1. Do a careful audience and task analysis

2. Determine the number of tasks

3. Determine the best approach to the step-by-step discussion

4. Design groupings of tasks

Common Sections in Instructions

Writing Style

Illustrating Your Instructions

Formatting Your Instructions

Share This Book

7 best technical writing examples to improve your skills

Afoma Umesi

Table of contents

Lead with Content

Padma Gillen

What is technical writing?

6 Steps to Writing a Technical Piece That People Actually Want to Read