assignment for technical writing

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

Technical Writing
Technical Writing One In-Class Exercises
Português – Brasil

Technical Writing One: In-class exercises

This section contains the in-class exercises for Technical Writing One. We designed this section to accompany the in-class portion of Technical Writing One. If you stumbled on this section and are not currently taking the in-class portion of Technical Writing One, this section might be rather challenging to understand.

These exercises will also be far more meaningful if you've completed the pre-class work .

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2020-04-02 UTC.

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

selected template will load here

This action is not available.

1: Introduction to Technical Writing

Last updated
Save as PDF
Page ID 89443

CHAPTER OBJECTIVES

Define technical communication.
Distinguish technical writing from academic writing.
Explain the features of technical writing style.
Introduce the concepts of audience, culture, and ethics as they apply to technical writing.

What is Technical Writing?

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

Technical writing is designed for users in technical fields such as engineering, chemistry, computer information software and systems, medical professions, aeronautics, robotics, automotive, etc.

Technical writing is designed to:

inform by anticipating and answering audience questions;
instruct the audience to perform a task or follow a procedure, and
persuade the audience via explanations, analysis, and solutions.

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

CHARACTERISTICS OF TECHNICAL WRITING

Technical communication is an audience-centered means of communication that provides the reader with clear, accurate, and ethically represented information. According to the Society for Technical Communication, technical writing includes the following characteristics:

“Communicating about technical or specialized topics, such as computer applications, medical procedures, or environmental regulations.”
“Communicating by using technology, such as web pages, help files, or social media sites.”
“Providing instructions about how to do something, regardless of how technical the task is or even if the technology is used to create or distribute that communication.”

The Meaning of "Technical"

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

Academic Writing Versus Technical Writing

Technical communication is distinct from the academic forms of writing you may be more familiar with. The academic writer’s purpose may be to write an essay, a story, a research paper, etc. Such assignments are often designed so that students can “write to learn” and show mastery of information covered in class. Additionally, in academic writing context, student-writers join a conversation that is occurring on a particular topic.

Technical communication, however, is intended for another purpose. These documents convey information to audiences who may or may not have prior knowledge of the material discussed. Technical communicators must, therefore, determine the needs of their audience and design documents that convey information in an accessible and appropriate manner. Depending on the context of communication, it might also be necessary to convey information in a concise and efficient manner, succinctly presenting points and cutting extraneous or potentially distracting material.

Workplace Writing

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

STRATEGIES TO ACHIEVE TECHNICAL WRITING TASKS

Professional technical writers rely on these strategies to ensure the technical accuracy of their work:

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

Considerations of Technical Documents

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

The Importance of Audience

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

Cultural Communication

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

Figure 1 The Cultural Iceberg

Technical writers have a responsibility to their readers and to their employers to follow ethics when writing reports. Technical writers must use words that demonstrate valid appeals to reason, avoiding emotional words and phrases that appeal to basic emotion instead of justifiable reasoning. In addition, technical writers must use valid references to support ideas and strategies, avoiding referencing non experts to sway readers’ support. Also, technical writers must use accurate numbers to report data, avoiding charts and tables that skew data. Using any type of fallacies in technical writing is unethical and could result in dire consequences. Not only do technical writers have a responsibility to report accurate information, but they also have a responsibility to credit accurate sources of information. At no time is it acceptable to rearrange information in order to attempt to indicate that the writer is the source of someone else’s idea or to indicate that the writer read a report that included information he/she cited, when the primary source of the information was cited in another report. All sources must be referenced accurately in the text and cited on a reference page.

Overview of the Technical Writing Style

Technical writing takes complicated ideas and organizes and explains those ideas in easy-to-understand language. The reader of technical documents does not read to engage in a discussion or be entertained. The audience of technical documents wants information. In short, technical writing provides information and seeks to solve problems and help the reader learn.

While some technical writing is composed for experts within the field, most technical writing is composed for the ordinary user - the consumer. While technical writing can organize information so it persuades the user, it must always present complete and accurate information. Technical writing does not use emotionally charged language, redundant adjectives, colloquialisms, or words or phrases that are open to interpretation. As the Society of Technical Writing explains, technical communicators employ a user-centered approach to provide "the right information, in the right way, at the right time to make someone’s life easier and more productive."

Features of Technical Writing

Technical documents must be reader-centered. The information is explained and presented in a style that is easy to navigate and understand. Technical documents value the reader’s time by using the following features:

Accessible – Think about the users of your document. You understand the material and created the document based on that knowledge and understanding, but for your audience, this is new information. So the information must be explained and presented in a style that is easy to understand and follow.
Collaborative - technical documents must consider multiple perspectives; therefore, they are frequently composed by a team of writers.
Concise –To write concisely does not mean to use fewer words. Instead, it means to use all the words you need but only the words you need.
Efficient page design: Use headings, numbered or bulleted lists, tables, easy-to-read fonts, white space, and other elements to help the reader navigate through the material.
Logical organization: use chronological order and emphasize important information.
Meaningful content: include all of the information needed but none of the information that is not needed.
Supplemental material: Abstracts, footnotes, glossary, appendix, definitions, etc., provides readers with additional information when needed.
Visual elements: Use charts, graphs, or images to clarify written concepts or relationships.

Formatting and Language

Formatting and appropriate language are the basic design elements of all technical documents. A format that shows a hierarchical structure and a coordinate structure of information leads the reader through the text. Readers should be able to identify a writer’s organizational pattern very quickly when reading a technical document. This sometimes refers to a document being “reader-friendly.” In addition, using appropriate language is significant in providing the reader with a thorough understanding of the purpose of the document, how the document relates to the reader’s needs, and what action is expected of the reader.

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

The following table provides general specifications for many types of technical writing documents:

Table 3.1. Document Formatting

Readability in Publications

The way a text looks matters to a reader, so it should matter to a writer. Letters, reports, and websites are more than just words on a page or a screen. How ideas are arranged and delivered in physical form, whether electronically or on paper, can make reading seem intimidating, confusing, or downright unfriendly, even if the content itself is perfect. Your text is like a room for your ideas. Sometimes you want readers to get in and get out quickly, but often, you want them to sit down and make themselves comfortable, put their feet up and stay awhile. Whatever the case, you should be in control of the reader’s experience.

To make a document more reader-friendly, many technical writers rely on visuals to achieve this goal. See Chapter 15, "Visuals in Technical Documents " for detailed information about using visuals.

Ways effective design enhances a document

Effective design makes a document accessible

Good design helps readers understand your information.
Good page design helps readers locate information quickly.
Good design helps readers notice highly important content.

Effective design affects readers’ attitudes, thereby increasing a communication’s persuasiveness.

Good design encourages readers to feel good about the communication itself.
Good design encourages readers to feel good about the communication’s subject matter.

Because page design can have such a significant impact on your communication’s usability and persuasiveness, you should approach design in the same reader-centered manner that you use when drafting text and graphics. Think continuously about your readers, including who they are, what they want from your communication and the context in which they will be reading.

It helps to think about the building blocks of a page design in the way that professional graphic designers do. When they look at a page, they see six basic elements:

Text : Paragraphs and sentences.
Headings and titles : Labels for sections of your communication.
Graphics : Drawings, tables, photographs, and so on — including their captions.
White space : Blank areas.
Headers and footers : The items, such as page numbers, that occur at the top or bottom of each page in a multi-page document.
Physical features : These include paper, which may take many shapes and sizes, and bindings, which come in many forms.

Figure 3.1. Overview of design elements. Notice how your eye is drawn to the blue header and the boxed elements. In these spaces, you can highlight the important parts of your message:

Technical writing is designed to inform, instruct, or persuade an audience. It is informative and concise. Technical writers often collaborate with others in their organizations to develop documents that are formatted and designed to inform their audience in accessible ways. All forms of technical writing -- memos, letters, proposals, reports, and so on -- have different conventions for format and design. Technical writing differs from the academic writing to which many students are accustomed. As you continue exploring concepts of technical communication in this course, remember these introductory concepts to technical writing and work to apply them to the documents you create.

GENERAL TIPS ABOUT TECHNICAL WRITING

Remember that technical writing is not just about computers or engineering. The term should be considered more broadly than that.
Audience is crucial. Before creating any technical document, be certain you understand your audience's identity and needs.
Format your technical documents differently than you might format an academic writing assignment.
Consider cultural and ethical concerns and complications as you develop your documents.

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

Society for Technical Communication. (2021). Defining Technical Communication. https://www.stc.org/about-stc/defini...communication/ .

This work "Introduction to Technical Writing" is a derivative of " What is Technical Communication? " by Chelsea Milbourne, Anne Regan, Morgan Livingston, & Sadie Johann, Technical Writing for Technicians CC-BY Will Fleming, and " ENGL 145: Technical and Report Writing " by Amber Kinonen,used under a CC BY license. "Introduction to Technical Writing" is licensed under CC BY 4.0 by Tamara Girardi and Mary Richards.

Mindful Technical Writing: An Introduction to the Fundamentals

(2 reviews)

Dawn Atkinson, Montana Technological University

Stacey Corbitt, Montana Technological University

Publisher: TRAILS

Language: English

Formats Available

Conditions of use.

Learn more about reviews.

Reviewed by Cynthia Fields, Instructor, Piedmont Virginia Community College on 5/21/21

Comprehensiveness rating: 4 see less

According to the preface, "Mindful Technical Writing" is designed for courses with a variety of focuses, including developmental, technical, workplace, and academic writing. At 770 pages, the textbook can realistically only be used by selecting chapters relevant to specific course outcomes. Topics covered include an introduction to technical writing, style and mechanics, document design, doing research, college success strategies, and genres associated with workplace and academic writing. Because the textbook spans so many topics, at times the content lacks necessary depth, so this book would best be used as a supplement to other courses texts. The core strength of this textbook is actually the substantial, 12-chapter unit on academic success, which covers topics such as organization, time management, understanding assignments, reading and note-taking strategies, how to access college resources, and taking online courses. As such, this book’s unit could also be used in a variety of introductory courses beyond writing, especially those focusing on college success.

Content Accuracy rating: 5

The content is accurate and error-free. It does not overly rely on disciplinary jargon, but it does present concepts typical of introductory rhetoric, composition, and technical writing courses.

Relevance/Longevity rating: 4

The content is up-to-date comparable to most commercial technical writing textbooks; however, similar to those, it does not dedicate sufficient space to writing in digital environments. It does not rely on current “hot topics” to explain concepts, so the content will not be rendered obsolete in a short period of time.

Clarity rating: 2

The most significant weakness of this textbook is not the language itself but the cluttered and non-intuitive visual layout that makes the organizational scheme of each chapter exceptionally hard to follow. The book would benefit from an entire reworking of the document design. There are too many headings, subheadings, sub-subheadings, images, activities, boxed content, bulleted points, numbered points, and case studies, which need more distinct visual delineations and white space to keep the reader clear on how concepts are related to each other.

Consistency rating: 4

The content is consistent. However, the visual clutter mentioned above makes it difficult to follow the textual organization so that even if technically consistent, the organization of chapters feels jumbled.

Modularity rating: 4

Portions of this text can be strategically selected based on specific course outcomes. While selecting certain chapters should be simple for instructors, it would be more difficult to select only portions of chapters because of the lack of visual clarity, as well as the lack of subheadings in the Table of Contents. The textbook also presents a number of in-class and homework activities associated with each chapter that will be useful for students as well as novice instructors who may need guidance on how to structure effective class sessions.

Organization/Structure/Flow rating: 3

The Table of Contents does not number the chapters and does not list subheadings to chapters, which will make it difficult for students and instructors to find relevant information. This labeling is particularly necessary for a book of this size because it covers so many diverse topics. A more thorough listing of the organization in the Table of Contents is also necessary because chapter and units jump around in a non-intuitive manner. For example, the book starts with technical writing concepts, then moves to using sources typical for composition research papers, then addresses student success strategies, then goes back to genres associated with technical writing, and finally ends on general academic writing in college courses. The book does not include an index or glossary, which would also help with its accessibility problems.

Interface rating: 3

Users should note that the downloaded PDF does hyperlink the Table of Contents to specific chapters, but the text does not do so when accessed directly from its location on a Google drive. Most images and figures in the text are frustratingly pixelated but still legible. All of the hyperlinks I followed still worked.

Grammatical Errors rating: 5

I did not notice any typos or grammatical errors.

Cultural Relevance rating: 3

The textbook itself does not use language that is insensitive or offensive. However, the content does not sufficiently address intercultural communication, diversity, bias, ethics, and non-inclusive language. (There are a few instances in the text where these issues are mentioned, but they do not receive significant treatment.) Instructors will need to supplement this absence with other course materials.

Overall, the strength of this textbook is its focus on strategies for academic success, which could be used in many classes beyond those dealing with writing. The content in this area is substantial, useful, and far more detailed than most introductory writing textbooks. New students in a variety of classes would benefit greatly from this information. Instructors may also find individual chapters useful to supplement course content but would find using the textbook as a whole uneven and unwieldy. If a document or graphic designer could re-do the visual layout in future editions, the book's accessibility and usefulness would be greatly enhanced.

Reviewed by Jennifer Banas, Professor, Northeastern Illinois University on 4/26/21

Comprehensiveness rating: 5 see less

Though the text’s title suggests a focus on technical writing, this book offers much more. Technical writing is a type of writing in which an author conveys information in the form of directions, instructions, or an explanation. It is typically regarded as different from creative, academic, or business writing. While this book does cover technical writing in Unit VIII, the authors’ expanded view of technical writing embraces academic writing as well. To ensure audience and purpose are addressed, both academic and technical writers must aim for writing that is clear, coherent, concise, concrete, correct, complete, and courteous. And like a pun within a pun, this text on technical writing is a well-written piece of technical writing. It can serve as an instructional manual for the many types of writing one might perform in the workplace, as well as in academic settings. In this way, the text also serves as a reference guide to writing for students, instructors, and other uses seeking information about how to write in various situations.

As will be discussed in Modularity, this text could be used in parts or in whole. If in whole and for a course, an instructor likely would need to reorganize and select units to fit the goals of a course. The comprehensiveness of the text would make it difficult to cover all units in a single academic semester. Further, some topics are covered more in-depth than others. For example, Unit IV Working with Sources, Unit V Conducting Research, and Unit IX Producing Academic Writing are units where the authors provide both depth and breadth. Other units, such as Unit III Attending to Design, attend only to breadth, serving more as introductions or overviews.

Though the text does not have an index, the table of contents makes it easy to make decisions about what units to include. An index, however, would have facilitated finding micro-topics or -skills that are covered in multiple units. The text does not include but would benefit from having a glossary. Topic and skill-specific vocabulary are introduced at the beginning of each chapter, but a glossary would allow a user to look up terms used when they are used in context.

The content is accurate and largely error-free. The lead author has had educational preparation in journalism and linguistics and at the time of this review is serving as the campus writing director at a university. The second author, too, has had educational preparation in technical writing and is serving as a writing instructor. These qualifications lend to the confidence one might have in the accuracy of the text.

The text incorporates website screenshots, handouts, and other visuals from secondary sources. Though this reviewer did not critically analyze each of these tools, those reviewed did appear to be accurate and error-free.

As for bias, the incorporation of these secondary sources helps to provide a broad perspective on the elements of writing. Further, the written text incorporates and cites many references, many for which a link to the original source is provided. These features help to reduce the potential for bias.

Relevance/Longevity rating: 5

The skills and styles taught reflect the current practices of many recognized writing styles (e.g. APA, Chicago, MLA, etc.) Table 1 in the Selecting a Style Guide chapter in Unit IV Working with Resources makes this clear. That said, given that these styles are frequently updated, it's possible that the text could become out of date if used at a later time. This means that instructors and users of the text might need to check with individual style guides to assure currency. As for topics, the text does include necessary writing skills for current times such as email correspondence and social media posts. As new forms of communication are developed, the text would need to be updated to reflect these.

Clarity rating: 5

The text is written by authors whose background is in writing and it was delivered as such. Defined vocabulary, examples, graphic organizers, and tables help to provide clarity consistently and adequately.

Consistency rating: 5

Although this text incorporates many secondary sources, the authors provide the narrative and structure. This allows for consistency in terminology and the organization of each chapter. Each chapter has a summary, objectives, introduction, and vocabulary. Each chapter ends with a conclusion and a homework assignment for further practice. Only one chapter, the Introduction to Technical Writing, contains a strong voice from a contributor that serves as an expert. However, that chapter is co-written with the text’s lead author.

Modularity rating: 5

Per the text’s authors “This book’s modular design and ample coverage of topics and genres means that it can be used flexibly over semester-long or stretch courses, allowing instructors and students to select the chapters that are most relevant for their needs.” At 770 pages, course instructors using this text will need to select which units and chapters to incorporate. For example, a college first-year experience course might only use Unit VI: Employing Strategies for College Success. An introductory composition course might use Unit II: Writing Documents, Unit IV: Working With Sources, and Unit IX: Producing Academic Writing. A mid- or upper-level methods course might use Unit IV: Working With Sources, Unit V: Conducting Research, and Unit IX: Producing Academic Writing. An introductory business or career-related writing course might use Unit VIII: Producing Instructions, Short Reports, and Presentations or Unit VII: Producing Correspondence, however, they would need to supplement with other sources to fill out their course. If the text is used for reference only or self-study purposes, the table of contents coupled with the individual chapter introductions and objectives can help the user to identify which units and chapters are most relevant.

Organization/Structure/Flow rating: 5

Topics and skill-sets are well-organized into units and chapters in a logical and clear fashion. Each chapter is organized the same way, thereby making it easy for a user to settle in with a predictable format.

Interface rating: 4

The text is free of significant interface issues. Many secondary sources visuals are included. Some are more clear than others, but all are legible. If printed out, some of these pages could be blurry. But given our digital age, it is not likely that these pages would be printed out. Graphic organizers, work-space boxes, and tables created by the authors are all clear and reproducible but mainly serve as cues for practice. Navigation problems are limited, in part, due to the absence of hyperlinks connecting the table of contents to the individual chapters or a glossary to terms. A second or revised edition would benefit from the inclusion of unit/chapter names at the top of each page so users know “where” they are.

The text contained no obvious grammatical errors. As indicated previously, many secondary sources are included in the text and this reviewer did not critically analyze all of these.

Cultural Relevance rating: 5

This text honors best practices in culturally responsive teaching (Hammond, 2014; Major, 2020). The text addresses both the affective and cognitive aspects of teaching and learning writing skills. Writing exercises prompt users to incorporate their own experiences into their writing such that they are writing about that which is most familiar. Skill development is scaffolded and many examples are provided. The consistency in which each chapter is structured provides a cognitive routine and this predictability helps to reduce overall cognitive load. The inclusion of essential vocabulary and the objectives at the beginning of each chapter provide all readers with background tools and clear expectations. Finally, the text is written in a conversational tone, it is accessible to a wide variety of users.

Overall, this is an extremely useful text and it is apparent throughout that the authors are passionate about their craft. Our academic program intends to incorporate different units into different courses to support the development of writing skills in context. A second or revised edition would benefit from a hyperlinked table of contents so that the user does not have to scroll through hundreds of pages to arrive at the chapter that they need. This reviewer also recommends that the authors either remove or further enhance the unit on design as this unit lacks enough detail to serve as a reference or comprehensive teaching tool.

Unit I: Exploring Technical Writing Fundamentals.
Unit II: Writing Documents.
Unit III: Attending to Design.
Unit IV: Working With Sources.
Unit V: Conducting Research.
Unit VI: Employing Strategies for College Success.
Unit VII: Producing Correspondence.
Unit VIII: Producing Instructions, Short Reports, and Presentations.
Unit IX: Producing Academic Writing.

Ancillary Material

About the book.

Welcome to Mindful Technical Writing: An Introduction to the Fundamentals, an open textbook designed for use in co-requisite course pairings of developmental writing and introductory technical writing, or indeed in other lower-division college writing courses that focus on building study skills alongside effective workplace and academic writing skills. It offers a no-cost alternative to commercial products, combining practical guidance with interactive exercises and thoughtfully designed writing opportunities.

This book’s modular design and ample coverage of topics and genres means that it can be used flexibly over semester-long or stretch courses, allowing instructors and students to select the chapters that are most relevant for their needs. By blending new material with reviews of key topics, such as academic integrity, the chapters provide fresh perspectives on matters vital to the development of strong writing skills.

About the Contributors

Dawn Atkinson , Montana Technological University

Stacey Corbitt , Montana Technological University

Contribute to this Page

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

What is Technical Writing?

Traditional definition of technical writing, new definition of technical writing, how is technical writing different than business writing, what is the job of a technical writer, career outlook for a technical writer, types of technical writing, a day in the life of a technical writer, skills needed for technical writing, how to improve your technical writing skills, the world is a tech writer’s oyster.

Are you looking to understand what technical writing is and how you can become more proficient?

Technical writing continues to be a highly coveted skill in the professional workplace. Demand is expected to grow at 10% from 2014 to 2024. This is faster than the average for all occupations.

In this article, we cover the exact definition of technical writing. We also show you an average day for a technical writer, how to improve your skills when writing complex documents, and why the field is quickly changing.

What is technical writing? The traditional definition of technical writing is:

Technical writing is the practice of documenting processes, such as software manuals or instructional materials. Traditionally, it was limited to user manuals of some sort.

Frankly, this definition has become outdated. Technology moves quickly, and lexicographers are often left playing catch up.

Today, technical writing encompasses all documentation of complex technical processes. It includes reports, executive summary statements, and briefs. Any time technical information is conveyed in writing at work, it is, by definition, technical writing.

This can include high-tech manufacturing, engineering, biotech, energy, aerospace, finance, IT, and global supply chain.

The format is no longer bound to lengthy user manuals. Technical information must be distilled and presented unambiguously. This can come in the form of technical reports, emails, policy, briefs, and press releases.

The bottom line is if you work in a technical field you are most likely performing technical writing.

The new definition starts to sound a lot like the definition of business writing .

However, a business writer focuses on business plans, case studies, e-books, and sales/marketing collateral. They are experts in strategy and business management.

In contrast, technical writers have a strong aptitude in the field of science, engineering, or IT. They are tasked with the compilation of technical documents such as instruction manuals and other instructional materials, guidebooks, technical product descriptions, and research reports.

There are quite a few differences between the two, which you can read about in this article .

Become a technical writer today and advance your career in our course

Our Technical Report Writing course includes instructor feedback and guidance at key points while you write an actual work document. Receive one-on-one coaching to review your final document.

The job of a technical writer will differ depending on the industry and company that they are employed with. But t he important task of a technical writer is taking the highly complicated and sometimes confusing subject matter, and putting it in a digestible format.

This is of particular importance in a variety of industries but specifically science or technology such as biotech, engineering, manufacturing, software, and healthcare.

Technical writers often work on multidisciplinary teams functioning as the mediator between the more technical staff and less technical readers. They will work closely with these teams to develop a communications strategy.

Their responsibilities can extend beyond just writing. They must understand the entire project from high-level goals to the intricacies of implementation.

Educational experience for a technical writer can vary, but the majority of professionals hold a BA in English with an emphasis in writing, journalism, communications, curriculum development, IT, software/computer, or engineering. Some also possess an MA in technical writing.

Over the past couple of years, the workplace has undergone a revolution in terms of how we communicate with colleagues, clients, and end-users. Due to fewer face-to-face meetings, technology , and the written word have become more important. This is a perfect platform for the burgeoning of the field of technical writing.

Technical writing jobs are growing at a faster rate than average, at 12%. The salary range of a technical writer varies, but the average median wage is $61,671 . A technical writer is defined as one who authors descriptive manuals and guides as it relates to the complex subject matter. Job duties include:

Researching topics
Writing technical documentation
Editing for publications
Revising technical documents (guidebook, reports, brochures, articles)

Check out the summary table below highlighting the differences in types of technical writing and industries that need these documents:

At first, it may be overwhelming to see so many different types of technical documents. But each document uses a similar writing process and draws on an established set of skills. If you develop a process, you can apply it to any technical document you are creating.

technical-writing-leonardo-da-vinci-notebook

Many excellent writers are intrigued by the work environment of a professional technical writer . They find the quiet and tranquility of the atmosphere as a genuine job perk. Being alone with just a computer for researching and crafting documents through a technical writing process appeals to the introverted. Writers from all corners of the globe share their love for a job that can be more of a passion.

When defining what technical writing is , it’s important to look at the persona of a technical writer and explore dominant character traits. Unsurprisingly, a professional in this field is marked as artistic and investigative . They are especially inquisitive. A fun fact is that Leonardo da Vinci is deemed the most famous technical writer of all time. Apparently, during the period of the Renaissance, he wrote ‘user manuals’ for his unique inventions.

As you further your understanding of technical writing and your technical knowledge, you may want to evaluate if it matches your personality type. It’s recommended to do a self-assessment and consider your personal strengths and talents when pursuing a new professional career.

To be a successful technical writer, there is a core set of skills that you will want to master. Here are some of the most common skills needed to be successful:

Research is one of the first steps in technical writing. After you have an assignment, you will be responsible for collecting the data (numerical and non-numerical) and turning it into valuable information.

Research can come from a variety of places including:

On-Site Data
Online and Intranet Publications
Libraries and Research Databases

After you have researched, you will need to synthesize and begin planning your document organization.

Audience perception

The technical information you research and gather has to be shaped for reader interest, understanding, and perception.

Technical writers often have to communicate highly technical information to a non-technical audience. Therefore, an early step in the most effective technical writing process is analyzing your audience carefully so you can match information to their needs.

Communication skills

Communication skills are imperative to be a successful technical writer. You will likely be working with multiple teams and individuals from differing roles.

Your ability to listen, record, and communicate will be crucial.

Technical skills

It is imperative that you understand the technical nature of the content you are writing about.

It is difficult to convey a concept that you have not mastered clearly. Many technical writers have academic or work experience in the topic they are writing about and many technical writers have job titles of engineer, geologist, seismologist, financial analyst, or business analyst. They are employed in technical positions and have to summarize information cross-functionally to other areas of the company.

Technical writing is slightly easier if you come from the technical side and are learning to write. It is sometimes more difficult if your background is in writing and you are trying to learn the technical content.

Excellent writing skills ensure your documents are easy to read and are free of errors. Writing encompasses many of the other skills on this list.

It is important that you have the correct tone, style, and format for your document.

Often these rules are outlined by the employing organization in a style guide.

Document design

It is important that the graphics aid the reader in comprehending the information. Graphs, tables, and charts are commonplace in technical reports.

You will also need to be proficient in formatting documents. The formatting should be professional and aid the reader in navigating the document. Headings should be easy to skim, and the content should be organized logically.

A poorly designed document will make it more difficult for the reader to understand the content. Document design is a key aspect of technical writing.

Fluency with digital tools

Today, writers must use multiple tools during the technical writing process. This often goes beyond basic text editors. Technical writers are expected to be able to create graphics and annotate images and screen captures and extract data from Excel and convey that data in charts and tables.

User research and testing

Some forms of technical writing may require user research and testing. An example application where detailed research and testing would be appropriate is a written guide instructing engineers how to fix a faulty mechanism on a deep ocean oil rig.

It is important that the documentation is easy to follow, especially if the application is crucial to a major function. To accurately write the guide, the writer may first observe how engineers solve the problem. They may use recording devices or just notes to write down the research. This type of research is closely related to testing.

Testing is necessary to ensure your document functions as intended.

After the writer has completed a draft of the document, they may give it to a test group to read. They can then observe the end users following the instructions in real-time.

They may follow up with a focus group or survey to get feedback on the usefulness of the document. They will use these real-world insights as they revise the document.

Even in less complex or critical applications, it is always a good idea to have a third party read over the text. This helps combat the curse of knowledge. The curse of knowledge is a cognitive bias that an individual has when trying to explain something they already understand. As an expert, it is hard to put yourself in the shoes of a learner who is less experienced.

This is why having a second set of eyes look at the document can help alert you to areas that need to be improved.

typing-technical-document-laptop-and-writing

Write any technical document and get instructor feedback and live coaching on your actual writing.

Our technical writing course is available for individuals and groups.

Here are several ways to improve your overall technical writing skills:

One of the best ways to become a better writer is to read. Reading helps you train your brain to understand how to write. The more you read, the easier writing will become for you.

It is critical that you are reading relevant and high-quality documents. Look for documents produced by competitors or writers in related industries. Examine their writing to determine how they organize information through written text.

Create a process

Having a process keeps you from “getting stuck” while writing. Having a clear workflow will help you systematically accomplish your work. We teach a specific process for technical report writing in our technical writing course .

Seek feedback

Getting subjective and objective feedback on your writing is one of the fastest ways to improve your skills. That is why we emphasize individual feedback in all of our courses.

To improve your writing, you need someone to review not only the grammar and syntax but also your approach and methods as a writer.

To truly master technical writing you need to get feedback from a mentor. This may be someone in your organization or through a professional development group. Another great option if you are taking an online course is working with your instructor to improve your writing techniques.

Take a course

Taking a class can be one of the most efficient ways to boost your writing skills quickly. You want to ensure you are enrolling in a course that specializes in technical writing.

It is imperative that the course includes one-on-one feedback and instruction. If you are considering taking an online course (or hiring an instructor to conduct an on-site or virtual workshop) make sure to check out our guide on how to choose an online business writing course .

Repetition is the key to cementing your new skills. Look to incorporate new concepts into your work. You can even review old work to critique what you would do differently if you were to write the document today.

Verify that the course you take includes practice opportunities. For example, does the course require you to map the organization and sequence of a technical document? Since this is a core technical writing skill, you want to make sure you get professional feedback on your ability to do this.

Now that you know precisely what technical writing is , it is an easy path forward. For the curious, educated, and lover of being alone with a laptop and cup of joe, you may view the prospect of a technical writer as the perfect gig.

The future is bright and the availability of job opportunities is wide. This is the ideal position for those seeking a second promising career or fresh out of school and in search of a writing position that holds great promise. For professionals who claim techno-savvy combined with writing prowess, this is a time of opportunity. Check out the multitude of job openings and job titles in technical writing spanning industry segments.

Online courses can help you become a stronger technical writer, increase your knowledge level, and hone excellent writing skills. To get ramped up ASAP, enroll in a special technical writing course tailored to aspiring and seasoned technical writers.

How to become a technical writer: a beginner’s guide, how to improve your technical writing, is business writing the same as technical writing, get notified of new articles.

Business Writing Skills (54)
Business Grammar (52)
Technical Writing (32)
Business Writing Resources (26)
Business Email Writing (17)
Business Writing Training (12)
Business Proposals (10)
Business Report Writing (7)
Business Proofreading (4)
Sales Writing (3)
Executive Summary Writing (2)
Customer Support Writing (1)
Bailey Lang (1)
Elisabeth O'Quinn (14)
Grace Cuddy (6)
Haley Larsen (4)
Kara Latz (10)
Katie Almeida Spencer (31)
Malcolm Stiefel (1)
Mary Cullen (134)
Samantha Taylor (2)
Terrance Collins (1)
Tom DuPuis (10)

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

ENGL210: Technical Writing

Course introduction.

Time: 86 hours
Free Certificate

Because the goal of this course is to improve your ability to write clear, comprehensible examples of technical writing, most subunits include short writing activities that will give you hands-on experience in many different writing tasks. Each unit also includes a series of writing self-assessments that will allow you to evaluate your own writing based on specific criteria and provide examples and commentary on how to write successfully. This practical focus on specific writing skills will help you learn the writing skills you will need in the workplace. By the end of the course, you will feel comfortable tackling a wide variety of workplace communications.

Course Syllabus

First, read the course syllabus. Then, enroll in the course by clicking "Enroll me". Click Unit 1 to read its introduction and learning outcomes. You will then see the learning materials and instructions on how to use them.

Unit 1: Audience Analysis

Imagine needing to make a phone call but not knowing what number to dial. Beginning a communications project without first establishing your audience is a lot like that phone call without a phone number. If you don't first know who you are communicating with, you can't determine what information they need and in what format. In this unit, we walk through the steps of audience analysis to determine who we are writing to, what they know, what they need to know, and the best ways to reach them.

When we first take on a writing project, we must first consider who we are communicating with. We should ask ourselves who they are, what they know, and what they need to know to take action.

After we conduct this audience analysis, the next steps in the process apply this analysis to writing choices. Different audiences require different approaches to word choice, tone, and formatting. We also use our audience analysis to anticipate issues and any concerns or questions the audience might have after accessing the communication we have created.

Completing this unit should take you approximately 7 hours.

Unit 2: Internal Communication: Writing Memos and Emails

Two of the most common forms of technical writing that you will encounter are the memo and the email. After completing an audience analysis, you must determine which form would be best for sending the message; memos and emails often rely on smaller amounts of information or requests for more information. In this unit, we cover the best practices for creating effective memos and emails.

Once the dominant form of communication in the workplace, memos typically serve as internal communication within an organization. Memos can update policies and procedures, announce meetings or organizational changes, or inform the internal audience as needed. Memos must typically be brief, concise, organized for readability, and addressed to targeted audiences with specific subject lines.

Emails, which often replace memos for internal communication, can be sent internally or externally. While this form of business communication must take into account the time constraints most readers face as a result of high email volume, people use emails to communicate issues both large and small. Emails must make use of strong subject lines, clear formatting, and concise writing. Email also presents some ethical challenges as the forwarding and BCC function enables you to easily share communications with larger audiences quickly and in a way that is documented for the longer term.

Completing this unit should take you approximately 9 hours.

Unit 3: External Communication: Formal Letters

While memos are used for internal communication and emails for both internal and external communication, formal letters are mainly used as an external means of communication. Understanding when a communications context requires the more formal delivery of a physical letter falls under the initial considerations of the audience analysis and design/formatting stages of the writing process.

Letters can range from friendly introductions to more formal announcements with accompanying legal documents. In their more serious capacity, letters seek to create a formal and documented chain of communication.

Two main formats exist for letters: the block format and the indented format. Both require the recipient’s and sender’s full names and addresses. They begin with a formal salutation and end with a complimentary closing. Their formal structure helps to convey authority and credibility.

Completing this unit should take you approximately 6 hours.

Unit 4: Using Visuals to Convey Information

Words are not the only way to present and share information with an audience. Technical writing often utilizes visuals to accompany written information and further deliver information to the audience. This unit leads you through the types of visuals available and the best practices for using them.

Visuals take many forms; they can be as simple as a photograph of a plant specimen or pie chart breaking down enrollment data or as complex as an embedded video or multi-page, hyperlinked, organizational chart. Visuals must be carefully selected to support the audience's understanding of the topic.

However strong they are on their own, visuals must be integrated into the text of the document. The written word supports the visuals, and the visuals further exemplify the meaning of the text. The two work in tandem to support the main idea of the document.

This unit will also cover the important tools needed to properly label, title, and document visuals used in a given communication context.

Completing this unit should take you approximately 11 hours.

Unit 5: Process Documentation

One of the most common formats of technical writing is the process document. The process document explains either how to do something or how something was accomplished. This can be used to teach people or to document a process for the record. These documents vary in level of formality based on audience, but they all share elements of formatting to keep the communication organized and effective. This unit takes you through the ways to create process documents.

Formatting is probably the first design concern for a process document. The writer must distinguish whether or not the audience will have the directions with them as they accomplish the task or if they must commit the task to memory. Beginning nursing students, for example, are taught the proper way to wash hands in a roughly 1,500-word document. This document details not just the steps of handwashing, but also explains why each aspect of the process is critical to overall handwashing success. This extra detail helps to embed the proper procedure into new nurses' minds; they will, after all, be washing their hands countless times during the day without the instructions handy. Recipes, on the other side of the spectrum, anticipate that the audience will have them close by as they prepare the food; as a result, these feature lots of white space and step by step formatting.

Process documents must also pay special attention to anticipating potential trouble spots or questions from the audience. Anticipating these moments enables the writer to save time overall and increases the chances that the audience can complete the process without difficulty. Note that in this unit we will work through the writing process to develop complete process documents. We'll start with planning before moving to initial drafting, then revising.

Unit 6: Writing Proposals

Proposals are another common form of technical writing. These reports can either be formal or informal depending on the context. Some examples of proposals can be simple estimates for home improvement projects to more complex and formal business plans. This unit covers how to craft proposals.

Like process documents, proposals also rely on formatting to help them convey professionalism and appeal to the audience. Appealing to the audience is key given the persuasive nature of proposal writing. Proposals seek to persuade the audience to take action on a requested item or task.

Like other forms of technical writing, a proposal begins with audience analysis and moves through the steps of planning, writing, and revision.

Completing this unit should take you approximately 4 hours.

Unit 7: Communicating on the Internet

As the Internet rapidly expands, so does the opportunity for businesses to share information and reach audiences online. Technical Writers are increasingly called upon to craft communications to reach a broad online audience. The unit explores how the Internet is used to communicate and how to apply the foundations of technical writing effectively to reach online audiences.

Reading and writing for the Internet presents certain challenges that the printed word doesn't. The largest concern is the shortened attention span of Internet-based readers and reduced reading comprehension. Given the scrolling feature and the ease of clicking away, savvy writers for the Internet tailor their communications with headings, short paragraphs, clear and engaging visuals, and links for further development.

Additional points to consider when writing for the Internet are how to use social media as a tool for both communications and marketing. Given how easy it is to share communication online, the technical writer should be well versed in the social media tools and the common practices for writing on each of the interfaces. For example, what works on a blog post would not work in a tweet. The technical writer must learn how to translate the same idea for several different types of social media and in a way that reaches the intended audience.

Completing this unit should take you approximately 12 hours.

Study Guide

This study guide will help you get ready for the final exam. It discusses the key topics in each unit, walks through the learning outcomes, and lists important vocabulary terms. It is not meant to replace the course materials!

Course Feedback Survey

Please take a few minutes to give us feedback about this course. We appreciate your feedback, whether you completed the whole course or even just a few resources. Your feedback will help us make our courses better, and we use your feedback each time we make updates to our courses.

If you come across any urgent problems, email [email protected].

Certificate Final Exam

Take this exam if you want to earn a free Course Completion Certificate.

To receive a free Course Completion Certificate, you will need to earn a grade of 70% or higher on this final exam. Your grade for the exam will be calculated as soon as you complete it. If you do not pass the exam on your first try, you can take it again as many times as you want, with a 7-day waiting period between each attempt.

Once you pass this final exam, you will be awarded a free Course Completion Certificate .

Home » Writers-House Blog » Technical Writing Assignments

Technical Writing Assignments

Technical writing is aimed to educate, inform, or explain how to do something. This type of writing is completely different from narrative writing because its purpose is to teach readers some specific ability or skill. This type of writing is detail-oriented and requires a deep understanding of the subject. Here is some information from writers-house.com that will help you approach technical writing in the right way.

Types of Technical Writing

There are three most common types of technical writing with examples:

Traditional technical writing

Articles for trade publications;
An analysis of a legal case;
A summary of medical experiments that should be published in a journal.

End-user documentation

A cell phone manual;
A how-to guide on using a scanner;
A manual that teaches home computer users to set up a network.

Technological marketing communications

Informative articles about the benefits of IT consulting services for businesses;
A sales pitch about a new type of software or a new device.

Types of Technical Writing Assignments

Technical writing is often required in such areas as engineering, chemistry, hardware and software development, biotechnology, etc. Technical writing is also used on various websites, as well as in handbooks, owner’s manuals, articles, etc. Examples of technical writing assignments include promotional brochures, training manuals, articles, and operation guides.

Training Manuals

Technical writers also create various training manuals. When writing a manual, they might provide such information as duties associated with a certain position, general information, standard procedures, corporate policies, end-user documentation, etc.

Operations Guides

When technical writers work on operations guides, they should perfectly understand their subject. It’s important to know that people who will be read a guide are likely beginners and therefore need detailed instructions and explanations. There are the following types of operations guides:

Engineering guides;
Installation guides;
Assembly instructions;
Computer software guides;
Owner’s manuals.

Promotional Brochures

The main purpose of promotional brochures is to inform readers about a certain offer. However, such brochures should also motivate readers to take this opportunity, using keywords and the right type of phrasing.

Online Articles

This is another type of technical writing, which is common on the internet. Most often, when people need a guide or instruction, they use search engines and read online articles. In this case, technical writing may vary from informative articles about a certain subject in general to detailed instructions.

Technical Writing Work

If you think about becoming a technical writer, you can choose one of many categories of technical writing described above. In addition, you should study your field and read relevant sources. Last but not least, you shouldn’t forget about training your writing skills.

Be the First to Comment!

Place your order

Essay Writer
Essay Writing Service
Term Paper Writing
Research Paper Writing
Assignment Writing Service
Cover Letter Writing
CV Writing Service
Resume Writing Service
5-Paragraph Essays
Paper By Subjects
Affordable Papers
Prime quality of each and every paper
Everything written per your instructions
Native-speaking expert writers
100% authenticity guaranteed
Timely delivery
Attentive 24/7 customer care team
Benefits for return customers
Affordable pricing

8.2 Conciseness

Successful technical writing is concise. Once you have written a solid draft, a document that has been well researched, take a step back and question whether or not you can delete half of the words. In a world where billions of instant messages and emails are sent daily, brevity is a virtue. Readers appreciate concise writing. They respect writers who can explain difficult matters simply.

Conciseness Improves Flow

Unfortunately, many writers use sentences that are too wordy. This is not to suggest that lengthy sentences can never be used (because they certainly can), but at times writers make the mistake of using more words than necessary to get their message across.

The above sentence makes sense, though the statement could be more precise if it were phrased a little differently. Describing the action first, followed by the reason, would improve it:

The above sentence conveys the same message and is more succinct and direct. True, the sentence omits certain parts: that Michelle “was supposed to have her car’s oil changed every 3,000 miles,” but we know this already (or can presume so) from the word “because.” The sentence also omits “she took her car to the mechanic,” because it’s obvious—mechanics typically perform oil changes. However, if it’s important for readers to know that she went to a mechanic, then it should be kept.

The first sentence example isn’t wrong; it just has some superfluous wording, which can disrupt your writing’s flow. Just as machines don’t have extra parts, sentences shouldn’t have extra words.

The above passage is unnecessarily wordy, imprecise, and, at times, confusing. It can be distilled into a single sentence as shown below:

Redundancy Reduces Conciseness

Writing concisely also involves avoiding redundancies. Redundancy happens when you use more words than necessary to express something, especially words and/or phrases in the same sentence that mean the same thing. Many writers are guilty of violating this rule at times, especially in their daily conversations. However, as you proofread your papers, try to double-check them for unnecessary phrases that you can omit or edit.

Here are some examples of redundant phrases:

“small in size” or “large in size”
“true facts”
“basic fundamentals”
“past history”
“evolve over time”
“consensus of opinion”

If you think about what’s being said in each of the above phrases, you can catch the redundancies: if something is small, for example, it’s small—you don’t need to tack on “in size” for clarification. If an event took place in history, then you don’t need to specify that it took place in “ past history” (all history is past). If something is a “fact,” then by definition it’s true.

Here are some additional examples of words and phrases that can often be pruned for clarity:

“kind of”
“sort of”
“really”
“basically”
“for all intents and purposes”
“actually”
“generally”

Eliminating Wordiness Improves Clarity

Here are a few methods to practice to help make your writing clearer and more concise:

Eliminate unnecessary determiners and modifiers

Writers sometimes clog up their prose with one or more extra words or phrases that seem to determine narrowly or to modify the meaning of a noun but don’t actually add to the meaning of the sentence. Although such words and phrases can be meaningful in the appropriate context, they are often filler and can easily be eliminated.

Change phrases into single words

Convert phrases into single words when possible.

Change unnecessary that, who, and which clauses into phrases

Convert modifying clauses into phrases or single words when possible.

Avoid overusing expletives at the beginning of sentences

Expletives are phrases of the form it + be-verb or there + be-verb. Such expressions can be rhetorically effective for emphasis in some situations, but overuse or unnecessary use of expletive constructions creates wordy prose.

Take the following example: “It is imperative that we find a solution.” The same meaning could be expressed with this more succinct wording: “We must find a solution.” But using the expletive construction allows the writer to emphasize the urgency of the situation by placing the word imperative near the beginning of the sentence, so the version with the expletive may be preferable.

Still, you should generally avoid excessive or unnecessary use of expletives. The most common kind of unnecessary expletive construction involves an expletive followed by a noun and a relative clause beginning with that, which, or who . In most cases, you can create a more concise sentence by eliminating the expletive opening, making the noun the subject of the sentence, and eliminating the relative pronoun.

Use active rather than passive verbs (for more information, see the section on active vs passive voice ).

The active voice emphasizes the person/thing doing the action in a sentence. To make a passive sentence active, put the subject at the beginning and follow it with a verb.

Omit words or phrases that explain the obvious or provide excessive detail

If you find passages that explain or describe in detail what would already be obvious to readers, delete or reword them.

Additional Resources

“ Brevity, Clutter, Concision ” from WritingCommons.org .
“ Writing Concisely .” from George Mason University’s Writing Center. Writingcenter.gmu.edu
“ Concision ” from the Purdue OWL .

COMMENTS

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).
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.
Technical Writing One: In-class exercises
Technical Writing One: In-class exercises Stay organized with collections Save and categorize content based on your preferences. This section contains the in-class exercises for Technical Writing One. We designed this section to accompany the in-class portion of Technical Writing One. If you stumbled on this section and are not currently taking ...
Technical Writing 101: Examples and How to Become One (2024)
Technical writing is a form of writing on a specific topic that requires guidance, instruction, or explanation. This writing style serves a unique purpose and therefore has very different qualities than other types of writing, such as creative writing, academic writing, or business writing. Because of this, technical writing is vital to a wide ...
Introduction to Technical Writing
Technical Writing seamlessly blends the art of communication with the nuances of technology. Tailored for a diverse audience, including writers, communicators, engineers, and IT professionals, this course serves as a beacon, guiding participants toward the creation of effective technical documents tailored to specialized audiences.
1: Introduction to Technical Writing
Technical writing is an audience-centered means of communication that provides a reader with clear and easy access to information. In the business world, time equates to profit, and profit is the force behind all professional interactions. The technical writer and reader have a vis-à-vis relationship.
11 Technical Writing Examples & Samples in 2024
Process documentation is a form of technical writing that is designed for internal use by organizations to share knowledge on how to complete a task, with an emphasis on creating consistent, company-wide procedures. Examples of this type of technical writing include step-by-step process guides, internal wikis, KPI and goal reporting, OKRs, and ...
Technical Writing
This open textbook offers students of technical writing an introduction to the processes and products involved in professional, workplace, and technical writing. The text is broken up into sections reflecting key components of researching, developing, and producing a technical report. Readers will also learn about other professional communication, designing documents, and creating and ...
Mindful Technical Writing: An Introduction to the Fundamentals
Welcome to Mindful Technical Writing: An Introduction to the Fundamentals, an open textbook designed for use in co-requisite course pairings of developmental writing and introductory technical writing, or indeed in other lower-division college writing courses that focus on building study skills alongside effective workplace and academic writing skills.
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 ...
33 Good Technical Writing Examples (Word & PDF)
Download 30 KB. #33. Even if technical writing skills take high-levels details, you should still explain these concisely and clearly to your audience. As a technical writer, you should come up with documents that are very clear, simple, and succinct. Sometimes, though, the results could just be the opposite.
What is Technical Writing? [A New Definition]
The traditional definition of technical writing is: Technical writing is the practice of documenting processes, such as software manuals or instructional materials. Traditionally, it was limited to user manuals of some sort. Frankly, this definition has become outdated. Technology moves quickly, and lexicographers are often left playing catch up.
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.
CH 2 Assignment: Revising/Translating
CH 2 Assignment: Revising/Translating. Part of a technical writer's job is to translate highly technical writing and complex concepts for laypeople (non-experts). Technical writing is often a form of communication between a specialist and a non-specialist (layperson), though sometimes it is between a specialist in one field and an expert in a ...
CH 1 Exercises: Analyzing Technical Writing
Exercise 1 (group) Locate some examples of what you consider to be technical writing. These may include correspondence, journal articles, lab reports, web pages, or advertisements. In small groups with other classmates, discuss how the documents reflect the characteristics of technical writing.
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 ...
ENGL210: Technical Writing
English. ENGL210: Technical Writing. Learn new skills or earn credit towards a degree at your own pace with no deadlines, using free courses from Saylor Academy. Join the 1,839,519 students that started their journey with us. We're committed to removing barriers to education and helping you build essential skills to advance your career goals.
Examples of Technical Writing Assignments
Examples of Technical Writing Assignments, Professor Shinall. Course. Technical Writing (TCOM 2010 ) 13 Documents. Students shared 13 documents in this course. University Kennesaw State University. Academic year: 2020/2021. Uploaded by: Chloe Helton. Kennesaw State University. 0 followers. 144 Uploads 34 upvotes.
CH 7 Assignment: Technical Descriptions
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.
High School Technical Writing Activities
Manage Classes & Assignments. Sync with Google Classroom. Create Lessons. Customized Dashboard. Explore high school technical writing activities and resources. Inspire your students with videos, games, and activities, all aligned to state and national standards.
4.2 Memos
4.2 Memos. A memo (short for memorandum) is a type of document typically used to communicate with others in the same organization. Memos (or memoranda) are generally used for fairly short messages of a page or less, but informal reports of several pages may also employ the memo format. While many workplaces use email (whose format originates in ...
Technical Writing Assignments
Technical Writing Assignments. Technical writing is aimed to educate, inform, or explain how to do something. This type of writing is completely different from narrative writing because its purpose is to teach readers some specific ability or skill. This type of writing is detail-oriented and requires a deep understanding of the subject.
8.2 Conciseness
8.2 Conciseness. Successful technical writing is concise. Once you have written a solid draft, a document that has been well researched, take a step back and question whether or not you can delete half of the words. In a world where billions of instant messages and emails are sent daily, brevity is a virtue. Readers appreciate concise writing.

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

Technical Writing One: In-class exercises

1: Introduction to Technical Writing

CHAPTER OBJECTIVES

What is Technical Writing?

CHARACTERISTICS OF TECHNICAL WRITING

The Meaning of "Technical"

Academic Writing Versus Technical Writing

Workplace Writing

STRATEGIES TO ACHIEVE TECHNICAL WRITING TASKS

Considerations of Technical Documents

The Importance of Audience

Cultural Communication

Overview of the Technical Writing Style

Features of Technical Writing

Formatting and Language

Readability in Publications

Ways effective design enhances a document

GENERAL TIPS ABOUT TECHNICAL WRITING

Mindful Technical Writing: An Introduction to the Fundamentals

Formats Available

Table of Contents

Ancillary Material

About the Contributors

Contribute to this Page

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

What is Technical Writing?

Table of Contents

Become a technical writer today and advance your career in our course

Audience perception

Communication skills

Technical skills

Document design

Fluency with digital tools

User research and testing

Write any technical document and get instructor feedback and live coaching on your actual writing.

Create a process

Seek feedback

Take a course

Related Articles

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

1. Identify Your Audience

2. Dig Deep in Your Research

3. Create an Outline

4. Focus on Readability

5. Add Visuals

6. Cut the Fluff

7 of the Best Technical Writing Examples from Technical SMEs

Pipedrive’s Developer Documentation

University of Wisconsin Onboarding Tool Kit

Cell Reports Medical Study

LG Refrigerator Manual

Mashable India’s User Agreement