Basics of scientific and technical writing

  • Career Central
  • Published: 01 March 2021
  • Volume 46 , pages 284–286, ( 2021 )

Cite this article

  • Morteza Monavarian 1 , 2  

5065 Accesses

2 Citations

6 Altmetric

Explore all metrics

Avoid common mistakes on your manuscript.

Introduction to scientific/technical writing

Scientific/technical writing is an essential part of research. The outcome of a research activity should be shared with others in the form of scientific paper publications; some ideas require a patent to reserve the implementation rights; and almost any research activity requires a funding source, for which a grant proposal is necessary. Therefore, it is crucial to know the differences among writing papers, patents, and grant proposals and how to prepare them in a research environment ( Figure 1 ).

figure 1

Three major types of scientific/technical writing covered in the three-part series.

The publication of papers is a standard way to share knowledge and transfer methods in scientific communities, thus a pivotal part of any research activity, especially in an academic environment. In industry, where financial profit is a key factor, patents are possibly more favorable.

Types of paper publications

There are different types of paper publications, depending on the content, audience, purpose, length, and scope: original research, review articles, invited articles, conference proceedings, comments/errata, and press releases ( Figure 2 ).

Original research articles may be published in journals or conference proceedings (or preprints in arXiv) and target specific audiences within a field of research. Journal research papers require peer review that typically involves an editor and two reviewers. For conference proceedings, there is usually no direct peer-review process, but the work has to be presented in the corresponding conference to be eligible for publication.

In contrast to original research articles, which are written on special topics within a field of research, review articles normally cover an overview of research and tend to be longer. Review articles do not necessarily reflect on novel data or ideas and could be similar to a book chapter. However, unlike review articles, book chapters or books are usually written when the target field of research is fully established. In a review paper, figures are typically not original and reprinted from other publications, for which a copyright permission from the original publishing journal is required.

Invited articles are written in response to an invitation by a journal editor or a conference organizer in a specific field of research or for a special issue. An invited article could be a review article or original research. Invited articles are normally written by peers or researchers with significant contributions to a field of research.

Other items published include comments or errata. The purpose of a comment on a published article is to bring points of criticism to the attention of the readers as well as the authors of the original article. The comments can be published in the same journal as the original paper. Errata correct mistakes in an article after publication.

Finally, press releases target a more general audience and normally report on a review/overview of recently published research. The author of the press release is not the same as that of the original article. Unlike peer-reviewed research articles, press release articles are usually not citable.

figure 2

Six major types of paper publications.

Writing structures and styles

Different articles have different structures. A research article typically consists of a title, author list and affiliations, abstract, main body, conclusions, acknowledgments, and references.

A good title should be concise, to the point, and free of abbreviations. Author lists and affiliations include whoever has intellectually contributed to the paper (identifying at least one corresponding author and email address), with the order approved by all of the co-authors. A good abstract should give a full, but short, overview of the work with both qualitative and quantitative data summaries. An abstract should be self-contained, meaning it should not require a referral to a reference or figure. Abstracts are usually written in the present tense and have an active voice.

Unlike letters with no sections within the main body, the main body of research articles normally contains several sections (e.g., introduction, methods and approach, results, and discussions). The introduction should contain a deep literature review of the field as the basis for motivating the current work. The last paragraph of the introduction usually summarizes what to expect from the article. The following sections will demonstrate study methods, results, and discussions/interpretations of the results, including plots, tables, and figures.

Conclusions summarize the findings of the paper and may point out any future directions. The acknowledgment lists all funding support and gratitude toward anyone who helped with the work, not including those listed as co-authors. The reference section lists all references in a format described in the journal submission guidelines. Using reference management software (such as Zotero, Mendeley, BibTex) makes organizing the references less cumbersome. A good scholarly research article should have citations for almost any claims made within the main body, to ensure proper connections to the prior research in the field.

Unlike patents, papers require a deep scientific background and should be straight to the point. While patents include all aspects of the idea, papers typically have space limitations, so should therefore be concise. The data in research articles should speak for itself. The language of a research paper should be clear and simple and not include metaphors or slang.

Where to submit

The submission target depends on several factors: (1) scope of the journal, (2) length of the paper (letters versus regular length articles), (3) access (regular versus open access), and (4) impact factor (IF). The scope of the journal is probably the first thing to consider; you cannot publish a biological paper in a humanity journal. Regarding length, a letter is much shorter and usually does not have section headings. It depends on the discipline, but sometimes letters are more favorable because of the shorter publication time, preparation simplicity, and more readability (takes less time to read, which may also improve the visibility of the paper). In terms of access, you may pay publication charges to receive open access, or some journals charge publication fees upon acceptance. Open access papers could potentially get more visibility than normal publications.

IF is a specific journal parameter indicating the average number of citations per published article over a certain period of time. Paying serious attention to IF could oppose the mission of science itself, as it could mean that you judge a paper only by where it is being published and not by its intrinsic values (also called high IF syndrome).

Submission, peer-review, and decisions

Your article will enter the peer-review process upon submission. If done properly, the peer-review process not only avoids false or inconsistent data from being published (and helps science in this regard), but also improves your paper and removes any potential errors/issues or vague discussion. During submission, some journals may ask you to include/exclude reviewers. If there are researchers who may have a direct conflict with your work, you may list them as excluded reviewers. You may also suggest to include reviewers who have relevant experience.

Serving as a reviewer may help you with your own writing, as it assists in developing critical thinking. However, for the sake of science, try peer-reviewing for lesser-known journals (the high-impact journals already have many reviewers). Decisions on your article could be (1) reject: cannot be accepted to this journal; (2) referral to other journals; submit to another journal; (3) accept: accepted as is; (4) major revisions: not accepted, but could be accepted upon significant improvement (upon approval from reviewers); and (5) minor revision: accept but needs slight revisions (no need to go through a peer review again).

Copyrights and archiving

Most journals obtain copyrights from the authors before submission via a copyright transfer form. Hence, re-publishing the same data and plots in another journal is often forbidden. Also, the language of a paper should have a significant difference from an already published paper to avoid plagiarism. In the case where some content (e.g., figure or table) needs to be re-published in another paper (e.g., for review articles or thesis/dissertations), one can request a copyright permission from the original publishing journal. Also, archiving of one’s published papers in personal profile websites (e.g., Researchgate or LinkedIn) is usually forbidden, unless the paper is published as open access.

Final tips for paper publication

Read, read, read! There is probably no better way of improving writing skills than reading other articles and books.

Make illustrative and self-contained figures that can stand on their own.

Know your audience when selecting a journal. Find out which journals are normally targeted by people in your research community.

Protect yourself from high impact factor (IF) syndrome. Journals with a high IF may have very subjective decision criteria. It is sometimes more important to have your paper published than to spend a couple of years waiting for publication in a high-impact journal.

Serve as a reviewer. Get a sense of how a peer-review process feels in order to establish critical thinking. Before submitting your article, self-review.

Look forward to a constructive peer review. It definitely improves your paper (always good to have a view from different perspective).

Enjoy your publications!

Author information

Authors and affiliations.

Materials Department, University of California Santa Barbara, Santa Barbara, CA, USA

Morteza Monavarian

Solid State Lighting & Energy Electronics Center, University of California Santa Barbara, Santa Barbara, CA, USA

You can also search for this author in PubMed   Google Scholar

Additional information

This article is the first in a three-part series in MRS Bulletin that will focus on writing papers, patents, and proposals.

Rights and permissions

Reprints and permissions

About this article

Monavarian, M. Basics of scientific and technical writing. MRS Bulletin 46 , 284–286 (2021). https://doi.org/10.1557/s43577-021-00070-y

Download citation

Published : 01 March 2021

Issue Date : March 2021

DOI : https://doi.org/10.1557/s43577-021-00070-y

Share this article

Anyone you share the following link with will be able to read this content:

Sorry, a shareable link is not currently available for this article.

Provided by the Springer Nature SharedIt content-sharing initiative

  • Find a journal
  • Publish with us
  • Track your research

Purdue Online Writing Lab Purdue OWL® College of Liberal Arts

Professional, Technical Writing

OWL logo

Welcome to the Purdue OWL

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

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

In this section

Subsections.

Tips for Writing Technical Papers

Jennifer widom , january 2006, running example, paper title, the abstract, the introduction, related work, performance experiments, the conclusions, future work, the acknowledgements, grammar and small-scale presentation issues, versions and distribution.

Utah State University

Search Utah State University:

Technical writing standards, style and format.

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

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

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

General Format Guidelines

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

Technical documents typically contain:

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

Stylistic Elements

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

Acronyms and Abbreviations

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

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

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

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

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

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

Analogies and Metaphors

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

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

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

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

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

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

Conciseness

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

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

Contractions

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

Generalized Statements

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

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

Cats are nicer than dogs.

Gender-Neutral Terms

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

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

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

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

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

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

When using headings:

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

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

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

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

Key points to keep in mind when creating lists:

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

Narration (Point of View)

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

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

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

Students should get good grades in college.

Objectivity

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

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

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

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

Parallelism

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

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

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

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

SI versus Customary Units

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

Sentence Length

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

Technical Terms and Definitions

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

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

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

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

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

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

Voice (Active or Passive)

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

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

The boy hit the ball.

The ball was hit by the boy.

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

Use active voice when:

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

Use passive voice when:

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

Word Choice

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

How to write a technical paper or a research paper

By michael ernst, april, 2005 last updated: august 18, 2023, which details to include, make the organization and results clear, getting started: overcoming writer's block and procrastination, writing style, computer program source code, numbers and measurements, processing data, related work, when to submit your paper for publication, responding to conference reviews, norman ramsey's advice, other resources, introduction.

This document describes several simple, concrete ways to improve your writing, by avoiding some common mistakes. The end of this document contains more resources for improving your writing.

Some people believe that writing papers, giving talks , and similar “marketing” activities are not part of research, but an adjunct to it or even an undesirable distraction. This view is inaccurate. The purpose of research is to increase the store of human knowledge, and so even the very best work is useless if you cannot effectively communicate it to the rest of the world. If a paper is poorly written, then readers might conclude you spent as little effort on the research that it describes.

Equally importantly, writing papers and giving talks will clarify your thinking and thereby improve your research. You may be surprised how difficult it is to clearly communicate your ideas and contributions; doing so will force you to understand them more deeply and enable you to improve them.

Know your message, and stay on message

The goal of writing a paper is to change people's behavior: for instance, to change the way they think about a research problem or to convince them to use a new approach. Determine your goal (also known as your thesis), and focus the paper around that goal.

As a general rule, your paper needs to convince the audience of three key points. If any of these is missing or unclear, the paper will not be compelling.

  • The problem is important . The problem has a significant impact and consequences. You can buttress your argument by showing that others consider the problem important.
  • The problem is hard . Explain that obvious techniques and existing approaches do not suffice. Showing what others have tried can be effective here.
  • You have solved the problem. This is often demonstrated via experiments. Keep in mind how you expect the behavior of readers to change once they appreciate your contributions. You'll also need to convince readers that your contributions are novel. When expressing this, it is helpful to explain why no one else thought of your approach before (or why, if they thought of it, they would have rejected the approach) , and whether similar insights apply to other problems.

Before you write your paper, you need to understand your audience. Who will read your paper? What are their backgrounds, motivations, interests, and beliefs? What are the key points you want a reader person to take away from your paper? Once you know the thesis and audience, you can determine what points your document should make to achieve its purpose.

For each point in your paper, you need to explain both what and why . Start with what, but don't omit why. For example, it is not enough to state how an algorithm works; you should explain why it works in that way, or why another way of solving the problem would be different. Similarly, it is not sufficient to present a figure or facts. You must also ensure that reader understands the significance or implications of the figure and what parts of it are most important.

Your purpose is to communicate specific ideas, and everything about your paper should contribute to this goal. If any part of the paper does not support your main point, then delete or change that part. You must be ruthless in cutting every irrelevant detail, however true it may be. Everything in your paper that does not support your main point distracts from it.

Write for the readers, rather than writing for yourself. In particular, think about what matters to the intended audience, and focus on that. It is not necessarily what you personally find most intriguing.

A common mistake is to focus on what you spent the most time on. Do not write your paper as a chronological narrative of all the things that you tried, and do not devote space in the paper proportionately to the amount of time you spent on each task. Most work that you do will never show up in any paper; the purpose of infrastructure-building and exploration of blind alleys is to enable you to do the small amount of work that is worth writing about. Another way of stating this is that the purpose of the paper is not to describe what you have done, but to inform readers of the successful outcome or significant results, and to convince readers of the validity of those conclusions.

Likewise, do not dwell on details of the implementation or the experiments except insofar as they contribute to your main point. This is a particularly important piece of advice for software documentation, where you need to focus on the software's benefits to the user, and how to use it, rather than how you implemented it. However, it holds for technical papers as well — and remember that readers expect different things from the two types of writing!

The audience is interested in what worked, and why, so start with that. If you discuss approaches that were not successful, do so briefly, and typically only after you have discussed the successful approach. Furthermore, the discussion should focus on differences from the successful technique, and if at all possible should provide general rules or lessons learned that will yield insight and help others to avoid such blind alleys in the future.

Whenever you introduce a strawman or an inferior approach, say so upfront. A reader will (and should) assume that whatever you write in a paper is something you believe or advocate, unless very clearly marked otherwise. A paper should never first detail a technique, then (without forewarning) indicate that the technique is flawed and proceed to discuss another technique. Such surprises confuse and irritate readers. This mistake is often called “leading the reader down the garden path”.

When there are multiple possible approaches to a problem, it is preferable to give the best or successful one first. Oftentimes it is not even necessary to discuss the alternatives. If you do, they should generally come after, not before, the successful one. Your paper should give the most important details first, and the less important ones afterward. Its main line of argument should flow coherently rather than being interrupted. It can be acceptable to state an imperfect solution first (with a clear indication that it is imperfect) if it is a simpler version of the full solution, and the full solution is a direct modification of the simpler one. Less commonly, it can be acceptable to state an imperfect solution first if it is an obvious solution that every reader will assume is adequate; but use care with this rationalization, since you are usually wrong that every reader will jump to the given conclusion.

A paper should communicate the main ideas of your research (such as the techniques and results) early and clearly. Then, the body of the paper can expand on these points; a reader who understands the structure and big ideas can better appreciate the details. Another way of saying this is that you should give away the punchline. A technical paper is not a joke or a mystery novel. The reader should not encounter any surprises, only deeper explanations of ideas that have already been introduced. It's particularly irritating when an abstract or introduction states, “We evaluated the relationship between baldness and beekeeping”, with the key results buried pages later. A better abstract would say, “Male beekeepers are 25% more likely to be bald (p=.04), but there is no statistically significant correlation for female beekeepers.”

The same advice applies at the level of sections and paragraphs. It is a bad approach to start with a mass of details and only at the end tell the reader what the main point was or how the details related to one another. Instead, state the point first and then support it. The reader is more likely to appreciate which evidence is important and why, and is less likely to become confused or frustrated.

For each section of the paper, consider writing a mini-introduction that says what its organization is, what is in each subpart, and how the parts relate to one another. For the whole paper, this is probably a paragraph. For a section or sub-section, it can be as short as a sentence. This may feel redundant to you (the author), but readers haven't spent as much time with the paper's structure as you have, so they will truly appreciate these signposts that orient them within your text.

Some people like to write the abstract, and often also the introduction, last. Doing so makes them easier to write, because the rest of the paper is already complete and can just be described. However, I prefer to write these sections early in the process (and then revise them as needed), because they frame the paper. If you know the paper's organization and outlook, then writing the front matter will take little effort. If you don't, then it is an excellent use of your time to determine that information by writing the front matter. To write the body of the paper without knowing its broad outlines will take more time in the long run. Another way of putting this is that writing the paper first will make writing the abstract faster, and writing the abstract first will make writing the paper faster. There is a lot more paper than abstract, so it makes sense to start with that and to clarify the point of the paper early on.

It is a very common error to dive into the technical approach or the implementation details without first appropriately framing the problem and providing motivation and background. Readers need to understand what the task is before they are convinced that they should pay attention to what you are saying about it. You should first say what the problem or goal is, and — even when presenting an algorithm — first state what the output is and probably the key idea, before discussing steps. Avoid providing information that isn't useful to readers/users. It just distracts from the important content.

Some writers are overwhelmed by the emptiness of a blank page or editor buffer, and they have trouble getting started with their writing. Don't worry! Here are some tricks to help you get started. Once you have begun, you will find it relatively easier to revise your notes or first draft. The key idea is to write something , and you can improve it later.

Start verbally . Explain what the paper needs to say to another person. After the conversation is over, write down what you just said, focusing on the main points rather than every word you spoke. Many people find it easier to speak than to write. Furthermore, getting feedback and giving clarifications will help you discover problems with your argument, explanation, or word choice.

Outline . You may not be ready to write full English paragraphs, but you can decide which sections your paper will have and give them descriptive titles. Once you have decided on the section structure, you can write a little outline of each section, which indicates the subsection titles. Now, expand that into a topic sentence for each paragraph. At this point, since you know the exact topic of each paragraph, you will find the paragraph easy to write.

Stream-of-consciousness notes . Write down everything that you know, in no particular order and with no particular formatting. Afterward, organize what you wrote thematically, bringing related points together. Eventually, convert it into an outline and proceed as above. While writing notes, use phrases/keywords, not complete sentences. The phrases are quicker to write and less likely to derail your brainstorming; they are easier to organize; and you will feel less attached to them and more willing to delete them.

Divide and conquer . Rather than trying to write your entire document, choose some specific part, and write just that part. Then, move on to another part.

Re-use . Find other text that you have written on the topic and start from that. An excellent source is your progress reports — you are writing them, aren't you? This can remind you what was hard or interesting, or of points that you might otherwise forget to make. You will rarely want to re-use text verbatim, both because you can probably convey the point better now, and also because writing for different audiences or in different contexts requires a different argument or phrasing. For example, a technical paper and a technical talk have similar aims but rather different forms.

You must be willing to delete and/or rewrite your notes and early drafts. If you wrote something once, you can write it again (probably better!). Early on, the point is to organize your ideas, not to create finished sentences.

Be brief. Make every word count. If a word does not support your point, cut it out, because excess verbiage and fluff only make it harder for the reader to appreciate your message. Use shorter and more direct phrases wherever possible.

Make your writing crisp and to the point. Eliminate any text that does not support your point. Here is one way you might go about this; it is time-consuming but extremely effective. First, examine each section of the paper in turn and ask what role it serves and whether it contributes to the paper's main point. If not, delete it. Next, within each section, examine each paragraph. Ask whether that paragraph has a single point. If not, rewrite the paragraph. Also ask whether that point contributes to the goals of the section. If not, then delete the paragraph. Next, within each paragraph, examine each sentence. If it does not make a single, clear point that strengthens the paragraph, delete or rewrite it. Finally, within each sentence, examine each word, and delete or replace those that do not strengthen their point. You will need to repeat this entire process multiple times, keeping a fresh perspective on the paper.

Some people find it easier to follow this approach bottom-up, first cutting/rewriting words, then sentences, etc.

Passive voice has no place in technical writing. It obscures who the actor was, what caused it, and when it happened. Use active voice and simple, clear, direct phrasing.

First person is rarely appropriate in technical writing.

  • First person is appropriate when describing something that the author of the paper did manually. Recall that your paper should not be couched as a narrative.
  • Do not use “we” to mean “the author and the reader” or “the paper”. For example, do not write “In this section, we ...”.
  • Do not use “we” to describe the operation of a program or system. “We compute a graph” makes it sound like the authors did it by hand. As a related point, do not anthropomorphize computers: they hate it. Anthropomorphism, such as “the program thinks that ...”, is unclear and vague.

Avoid puffery, self-congratulation, superlatives, and subjective or value judgments: give the objective facts and let the reader judge. Avoid vague terms like “sizable” and “significant” (which are also subjective). Don't overuse the word “novel”.

Do not use words like “clearly”, “easily”, “obviously”, and “trivially”, as in “Obviously, this Taylor series sums to π.” If the point is really obvious, then you are just wasting words by pointing it out. And if the point is not obvious to readers who are not intimately familiar with the subject matter the way you are, then you are offending readers by insulting their intelligence, and you are demonstrating your own inability to communicate the intuition.

Prefer singular to plural number. In “sequences induce graphs”, it is not clear whether the two collections are in one-to-one correspondence, or the set of sequences collectively induces a set of graphs; “each sequence induces a graph” avoids this confusion. Likewise, in “graphs might contain paths”, it is unclear whether a given graph might contain multiple paths, or might contain at most one path.

When describing an experiment or some other event or action that occurred in the past, use past tense . For example, the methodology section might say “We ran the program”. It would be ungrammatical and confusing to use present tense, as in “We run the program”. Present tense is for ongoing events (“I write this letter to inform you...”) or regular events (“I brush my teeth each day”), but not past events (“Yesterday, I eat dinner with my family”). It is also correct to say “Our methodology was to run the program”, where you use past tense “was” and the infinitive “to run”.

When describing the paper itself, use present tense . “This paper shows that ...”. The reason for this is that the reader is experiencing the paper in real time.

Avoid gratuitous use of the future tense “will ...”, as in, “switching the red and green wires will cause the bomb to explode”. It is unclear when the action will occur. If it is an immediate effect, use the shorter and more direct “switching the red and green wires causes the bomb to explode”.

Use “previous work” instead of “existing work”. Your work exists, so “existing work” would refer to it as well.

In a list with 3 or more elements list, put a serial comma between each of the items (including the last two). As a simple example of why, consider this 3-element grocery list written without the clarifying last comma: “milk, macaroni and cheese and crackers”. It's not clear whether that means { milk, macaroni and cheese, crackers } or { milk, macaroni, cheese and crackers }. As another example, “I would like to thank my parents, Rene Descartes and Ayn Rand,” suggests rather unusual parentage, whereas “I would like to thank my parents, Rene Descartes, and Ayn Rand,” shows a debt to four people. I've seen real examples that were even more confusing than these.

In English, compound adjectives are hyphenated but compound nouns are not. Consider “the semantics provide name protection” versus “the name-protection semantics”.

Prefer unambiguous words to ambiguous ones. Do not use “as” or “since” to mean “because”. Do not use “if” to mean “whether”.

Use quotations sparingly. A clear paraphrase of the points that are relevant to your own work (along with a proper citation) is usually better than a long quotation from a previous publication.

Avoid third-person pronouns when you can. The old standard was “he”, which is masculine chauvinist. The new standard is “he or she”, which can be viewed as heteronormative and which some people find clumsy. An emerging standard is “they” as a first-person singular pronoun, which is inclusive but grammatically incorrect and confusing (see comments above about singular vs. plural number).

Some of the suggestions in this document are about good writing, and that might seem secondary to the research. But writing more clearly will help you think more clearly and often reveals flaws (or ideas!) that had previously been invisible even to you. Furthermore, if your writing is not good, then either readers will not be able to comprehend your good ideas, or readers will be (rightly) suspicious of your technical work. If you do not (or cannot) write well, why should readers believe you were any more careful in the research itself? The writing reflects on you, so make it reflect well.

Use figures! Different people learn in different ways, so you should complement a textual or mathematical presentation with a graphical one. Even for people whose primary learning modality is textual, another presentation of the ideas can clarify, fill gaps, or enable the reader to verify his or her understanding. Figures can also help to illustrate concepts, draw a skimming reader into the text (or at least communicate a key idea to that reader). Figures make the paper more visually appealing.

It is extremely helpful to give an example to clarify your ideas: this can make concrete in the reader's mind what your technique does (and why it is hard or interesting). A running example used throughout the paper is also helpful in illustrating how your algorithm works, and a single example permits you to amortize the time and space spent explaining the example (and the reader's time in appreciating it). It's harder to find or create a single example that you re-use throughout the paper, but it is worth it.

A figure should stand on its own, containing all the information that is necessary to understand it. Good captions contain multiple sentences; the caption provides context and explanation. For examples of good, informative captions, see the print editions of magazines such as Scientific American and American Scientist . The caption should state what the figure illustrates or what conclusion a reader should draw from it. Don't write an obvious description of what the figure is, such as "Code example". Never write a caption like “The Foobar technique”; the caption should also say what the Foobar technique is, what it is good for, or how it works. The caption may also need to explain the meaning of columns in a table or of symbols in a figure. However, it's even better to put that information in the figure proper; for example, use labels or a legend. When the body of your paper contains information that belongs in a caption, there are several negative effects. The reader is forced to hunt all over the paper in order to understand the figure. The flow of the writing is interrupted with details that are relevant only when one is looking at the figure. The figures become ineffective at drawing in a reader who is scanning the paper — an important constituency that you should cater to!

As with naming , use pictorial elements consistently. Only use two different types of arrows (or boxes, shading, etc.) when they denote distinct concepts; do not introduce inconsistency just because it pleases your personal aesthetic sense. Almost any diagram with multiple types of elements requires a legend (either explicitly in the diagram, or in the caption) to explain what each one means; and so do many diagrams with just one type of element, to explain what it means.

Some writers label all the types of figures differently — some as “figure”, others as “table” or “graph” or “picture”. This differentiation has no benefits, but it does have a drawback: it is very hard for a reader to find “table 3”, which might appear after “figure 7” but before “freehand drawing 1”. You should simply call them all figures and number them sequentially. The body of each figure might be a table, a graph, a diagram, a screenshot, or any other content.

Put figures at the top of the page, not in the middle or bottom. If a numbered, captioned figure appears in the middle or at the bottom of a page, it is harder for readers to find the next paragraph of text while reading, and harder to find the figure from a reference to it.

Avoid bitmaps, which are hard to read. Export figures from your drawing program in a vector graphics format. If you must use a bitmap (which is only appropriate for screenshots of a tool), then produce them at very high resolution. Use the biggest-resolution screen you can, and magnify the portion you will capture.

Don't waste text in the paper (and tax the reader's patience) regurgitating information that is expressed more precisely and concisely in a figure. For example, the text should not repeat the numbers from a table or graph. Text in the paper should add insight or explanations, or summarize the conclusions to be drawn from the data in the figure.

Your code examples should either be real code, or should be close to real code. Never use synthetic examples such as procedures or variables named foo or bar . Made-up examples are much harder for readers to understand and to build intuition regarding. Furthermore, they give the reader the impression that your technique is not applicable in practice — you couldn't find any real examples to illustrate it, so you had to make something up.

Any boldface or other highlighting should be used to indicate the most important parts of a text. In code snippets, it should never be used to highlight syntactic elements such as “public” or “int”, because that is not the part to which you want to draw the reader's eye. (Even if your IDE happens to do that, it isn't appropriate for a paper.) For example, it would be acceptable to use boldface to indicate the names of procedures (helping the reader find them), but not their return types.

Give each concept in your paper a descriptive name to make it more memorable to readers. Never use terms like “approach 1”, “approach 2”, or “our approach”, and avoid acronyms when possible. If you can't think of a good name, then quite likely you don't really understand the concept. Think harder about it to determine its most important or salient features.

It is better to name a technique (or a paper section, etc.) based on what it does rather than how it does it.

Use terms consistently and precisely. Avoid “elegant variation”, which uses different terms for the same concept to avoid boredom on the part of the reader or to emphasize different aspects of the concept. While elegant variation may be appropriate in poems, novels, and some essays, it is not acceptable in technical writing, where you should clearly define terms when they are first introduced, then use them consistently. If you switch wording gratuitously, you will confuse the reader and muddle your point. A reader of a technical paper expects that use of a different term flags a different meaning, and will wonder what subtle difference you are trying to highlight. Thus, don't confuse the reader by substituting “program”, “library”, “component”, “system”, and “artifact”, nor by conflating “technique”, “idea”, “method” and “approach”, nor by switching among “program”, “code”, and “source”. Choose the best word for the concept, and stick with it.

Do not use a single term to refer to multiple concepts. If you use the term “technique” for every last idea that you introduce in your paper, then readers will become confused. This is a place that use of synonyms to distinguish concepts that are unrelated (from the point of view of your paper) is acceptable. For instance, you might always use “phase” when describing an algorithm but “step” when describing how a user uses a tool.

When you present a list, be consistent in how you introduce each element, and either use special formatting to make them stand out or else state the size of the list. Don't use, “There are several reasons I am smart. I am intelligent. Second, I am bright. Also, I am clever. Finally, I am brilliant.” Instead, use “There are four reasons I am smart. First, I am intelligent. Second, I am bright. Third, I am clever. Fourth, I am brilliant.” Especially when the points are longer, this makes the argument much easier to follow. Some people worry that such consistency and repetition is pedantic or stilted, or it makes the writing hard to follow. There is no need for such concerns: none of these is the case. It's more important to make your argument clear than to achieve “elegant variation” at the expense of clarity.

Choose good names not only for the concepts that you present in your paper, but for the document source file. Don't name the file after the conference to which you are submitting (the paper might be rejected) or the year. Even if the paper is accepted, such a name won't tell you what the paper is about when you look over your files in later years. Instead, give the paper or its folder/directory a name that reflects its content. Another benefit is that this will also lead you to think about the paper in terms of its content and contributions.

Here is a piece of advice that is specific to computing: do not use the vague, nontechnical term “bug”. Instead, use one of the standard terms fault, error, or failure. A fault is an underlying defect in a system, introduced by a human. A failure is a user-visible manifestation of the fault or defect. In other circumstances, “bug report” may be more appropriate than “bug”.

Digits of precision:

  • Don't report more digits of precision than the measurement process reliably and reproducibly produces. The 3rd or 4th digit of precision is rarely accurate and generalizable; if you don't have confidence that it is both repeatable and generalizable to new experiments, omit it. Another way to say this is that if you are not confident that a different set of experiments would produce all the same digits, then don't report so much precision.
  • Don't report more digits of precision than needed to convey your message. If the difference between 4.13 and 4 will not make a difference in convincing readers, then don't report the extra digits. Reporting extra digits can distract readers from the larger trends and the big picture. Including an inappropriate number of digits of precision can cast suspicion on all of your results, by giving readers the impression that you are statistically naive.
  • Use a consistent number of digits of precision. If the measured data are 1.23, 45.67, and 891.23, for example, you might report them as 1.23, 45.7, and 891, or as 1.2, 46, and 890, or as 1, 50, and 900. (An exception is when data are known to sum to a particular value; I would report 93% and 7% rather than either 93% and 7.4% or 90% and 7%. Often it's appropriate to report percentages as whole numbers rather than using the same precision.)
  • If you do any computations such as ratios, your computations should internally use the full precision of your actual measurements, even though your paper reports only a limited number of digits of precision.
  • If a measurement is exact, such as a count of items, then it can be acceptable to give the entire number even if it has many digits; by contrast, timings and other inexact measurements should always be reported with a limited number of digits of precision.

Do not confuse relative and absolute measurements. For instance, suppose your medicine cures 30% of patients, and the placebo cures 25% of patients. You could report that your medicine's cure rate is .3, the placebo's cure rate is .25, and your medicine's cure rate is either .05 greater or 20% greater. (Other correct, but less good, ways to say the same thing are that it cures 20% more, 120% as many, or 1.2 times as many patients.) It would be inaccurate to state that your medicine cures 5% more patients or your medicine cures 120% more patients. Just as you need to correctly use “120% more” versus “120% as many”, you need to correctly use “3 times faster than” versus “3 times as fast as”. A related, also common, confusion is between “3 times faster than and 3 times as fast as”. And, “2 times fewer” makes absolutely no sense. I would avoid these terms entirely. “Half as many” is a much better substitute for “2 times fewer”.

Given the great ease of misunderstanding what a percentage means or what its denominator is, I try to avoid percentages and focus on fractions whenever possible, especially for base measurements. For comparisons between techniques, percentages can be acceptable. Avoid presenting two different measurements that are both percentages but have different denominators.

Your paper probably includes tables, bibliographies, or other content that is generated from external data. Your paper may also be written in a text formatting language such as LaTeX. In each of these cases, it is necessary to run some external command to create some of the content or to create the final PDF.

All of the steps to create your final paper should be clearly documented — say, in comments or in a notes file that you maintain with the paper. Preferably, they should be automated so that you only have to run one command that collects all the data, creates the tables, and generates the final PDF.

If you document and automate these steps, then you can easily regenerate the paper when needed. This is useful if you re-run experiments or analysis, or if you need to defend your results against a criticism by other researchers. If you leave some steps manual, then you or your colleagues are highly likely to make a mistake (leading to a scientific error) or to be unable to reproduce your results later.

One good way to automate these tasks is by writing a program or creating a script for a build system such as Ant, Gradle, Make, Maven, etc.

A related work section should not only explain what research others have done, but in each case should compare and contrast that to your work and also to other related work. After reading your related work section, a reader should understand the key idea and contribution of each significant piece of related work, how they fit together (what are the common themes or approaches in the research community?), and how your work differs. Don't write a related work section that is just a list of other papers, with a sentence about each one that was lifted from its abstract, and without any critical analysis nor deep comparison to other work.

Unless your approach is a small variation on another technique, it is usually best to defer the related work to the end of the paper. When it comes first, it gives readers the impression that your work is rather derivative. (If this is true, it is your responsibility to convey that clearly; if it is not true, then it's misleading to intimate it.) You need to ensure that readers understand your technique in its entirety, and also understand its relationship to other work; different orders can work in different circumstances.

Just as you should generally explain your technique first, and later show relationships with other work, it is also usually more effective to defer a detailed discussion of limitations to a later section rather than the main description of your technique. You should be straightforward and honest about the limitations, of course (do mention them early on, even if you don't detail them then), but don't destroy the coherence of your narrative or sour the reader on your technique.

Get feedback ! Finish your paper well in advance, so that you can improve the writing. Even re-reading your own text after being away from it can show you things that you didn't notice. An outside reader can tell you even more.

When readers misunderstand the paper, that is always at least partly the author's fault! Even if you think the readers have missed the point, you will learn how your work can be misinterpreted, and eliminating those ambiguities will improve the paper.

Be considerate to your reviewers, who are spending their time to help you. Here are several ways to do that.

As with submission to conferences, don't waste anyone's time if there are major flaws. Only ask someone to read (a part of) your paper when you think you will learn something new, because you are not aware of serious problems. If only parts are ready, it is best to indicate this in the paper itself (e.g., a TODO comment that the reader will see or a hand-written annotation on a hardcopy) rather than verbally or in email that can get forgotten or separated from the paper.

Sometimes you want to tell a colleague who is giving you feedback that some sections of your draft are not ready to be read, or to focus on particular aspects of the document. You should write such directions in the paper, not just in email or verbally. You will then update them as you update the paper, and all relevant information is collected together. By contrast, it's asking for trouble to make your colleague keep track of information that is in multiple places.

It is most effective to get feedback sequentially rather than in parallel. Rather than asking 3 people to read the same version of your paper, ask one person to read the paper, then make corrections before asking the next person to read it, and so on. This prevents you from getting the same comments repeatedly — subsequent readers can give you new feedback rather than repeating what you already knew, and you'll get feedback on something that is closer to the final version. If you ask multiple reviewers at once, you are de-valuing their time — you are indicating that you don't mind if they waste their time saying something you already know. You might ask multiple reviewers if you are not confident of their judgment or if you are very confident the paper already is in good shape, in which case there are unlikely to be major issues that every reviewer stumbles over.

It usually best not to email the document, but to provide a location from which reviewers can obtain the latest version of the paper, such as a version control repository or a URL you will update. That way, you won't clutter inboxes with many revisions, and readers can always get the most recent copy.

Be generous with your time when colleagues need comments on their papers: you will help them, you will learn what to emulate or avoid, and they will be more willing to review your writing.

Some of your best feedback will be from yourself, especially as you get more thoughtful and introspective about your writing. To take advantage of this, start writing early. One good way to do this is to write a periodic progress report that describes your successes and failures. The progress report will give you practice writing about your work, oftentimes trying out new explanations.

Whereas you should start writing as early as possible, you don't need to put that writing in the form of a technical paper right away. In fact, it's usually best to outline the technical paper, and get feedback on that, before you start to fill in the sections with text. (You might think that you can copy existing text into the paper, but it usually works out better to write the information anew. With your knowledge of the overall structure, goals, and audience, you will be able to do a much better job that fits with the paper's narrative.) When outlining, I like to start with one sentence about the paper; then write one sentence for each section of the paper; then write one sentence for each subsection; then write one sentence for each paragraph (think of this as the topic sentence); and at that point, it's remarkably easy just to flesh out the paragraphs.

You should not submit your paper too early, when it does not reflect well on you and a submission would waste the community's reviewing resources. You should not submit your paper too late, because then the community is deprived of your scientific insights. In general, you should err on the side of submitting too late rather than too early.

A rule of thumb is to submit only if you are proud for the world to associate your name with the work, in its current form . If you know of significant criticisms that reviewers might raise, then don't submit the paper.

Submitting your paper prematurely has many negative consequences.

  • You will waste the time of hard-working reviewers, who will give you feedback that you could have obtained in other ways.
  • You will get a reputation for shoddy work.
  • You will make the paper less likely to be accepted in the future. Oftentimes the same reviewers may serve two different venues. Reviewing a paper again puts a reviewer in a negative state of mind. I have frequently heard reviewers say, “I read an earlier version of this paper, it was a bad paper, and this version is similar.” (This is unethical because reviewers are not supposed to talk about papers they have reviewed, but nonetheless it is very common.) Now the paper will likely be rejected again, and the whole committee gets a bad impression of you. A reviewer who has read a previous version of the paper may read the resubmission less carefully or make assumptions based on a previous version. To sum up: it's harder to get a given paper accepted on its second submission, than it would have been to get the identical paper accepted on its first submission.

Here are some bad reasons to submit a paper.

It's true that the feedback from reviewers is extraordinarily valuable to you and will help you improve the paper. However, you should get feedback from other scientists (your friends and colleagues) before submitting for publication.

Those are true facts, and some people do “salami-slice” their research into as many papers as possible — such papers are called a “least publishable unit”. However, doing so leads to less impact than publishing fewer papers, each one with more content. If a paper contains few contributions, it is less likely to make a big impression, because it is less exciting. In addition, readers won't enjoy reading many pages to learn just a few facts.

Note: This point refers to taking a single research idea or theme and splitting it into multiple publications. When there are multiple distinct research contributions, it can be appropriate to describe them in different papers.

The reviewing process can be frustrating, because it contains a great deal of randomness: the same paper would be rejected by some reviewers and accepted by others. However, all great papers are accepted and all bad papers are rejected. For mediocre papers, luck plays a role. Your goal should not be to write great papers, not mediocre ones. Find a way to improve your paper. Recognize the great value of reviews: they provide a valuable perspective on your work and how to improve it, even if you feel that the reviewer should have done a better job.

If you aren't excited about the paper, it is unlikely that other people will be. Furthermore, the period after submitting the paper is not a time to take a break, but an opportunity to further improve it.

After you submit a paper, don't stop working on it! You can always improve the research. For instance, you might expand the experiments, improve the implementation, or make other changes. Even if your paper is accepted, you want the accepted version to be as impressive as possible. And if the paper is rejected, you need to have a better paper to submit to the next venue.

(This section is most relevant to fields like computer science where conferences are the premier publication venue. Responding to journal reviews is different.)

Many conferences provide an author response period: the authors are shown the reviews and are given limited space (say, 500 words) to respond to the reviews, such as by clarifying misunderstandings or answering questions. The author response is sometimes called a “rebuttal”, but I don't like that term because it sets an adversarial tone.

Your paper will only be accepted if there is a champion for the paper: someone who is excited about it and will try to convince the rest of the committee to accept the paper. Your response needs to give information to your champion to overcome objections. If there isn't a champion, then the main goal of your response is to create that champion. Your response should also give information to detractors to soften their opposition.

After reading the reviews, you may be disappointed or angry. Take a break to overcome this, so that you can think clearly.

For every point in the reviews, write a brief response. Do this in email-response style, to ensure that you did not miss any points. You will want to save this for later, so it can be better to do this in the paper's version control repository, rather than in a WYSIWYG editor such as Google Docs. (This assumes you have a version control repository for the paper, which you should!) Much of this text won't go in your response, but it is essential for formulating the response.

Summarize (in 5 or so bullet points, however many make sense) the key concerns of the reviewers. Your review needs to focus on the most important and substantive critiques. The authors of the paper should agree on this structure before you start to write the actual response.

Your response to each point will be one paragraph in your response. Start the paragraph with a brief heading or title about the point. Do not assume that the reviewers remember everything that was written by every reviewer, nor that they will re-read their reviews before reading your response. A little context will help them determine what you are talking about and will make the review stand on its own. This also lets you frame the issues in your own words, which may be clearer or address a more relevant point than the reviews did.

Organize your responses thematically. Group the paragraphs into sections, and have a small heading/title for each section. If a given section has just one paragraph, then you can use the paragraph heading as the section heading. Order the sections from most to least important.

This is better than organizing your response by reviewer, first addressing the comments of reviewer 1, then reviewer 2, and so forth. Downsides of by-reviewer organization include:

  • It can encourage you not to give sufficient context.
  • It does not encourage putting related information together nor important information first.
  • You want to encourage all reviewers to read the entire response, rather than encouraging them to just look at one part.
  • When multiple reviewers raised the same issue, then no matter where you address it, it's possible for a reviewer to overlook it and think you failed to address it.
  • You don't want to make glaringly obvious which issues in a review you had to ignore (for reasons of space or other reasons).
  • You don't want to make glaringly obvious that you spent much more time and space on one reviewer than another.

In general, it's best not to mention reviewer names/numbers in your response at all. Make the response be about the science, not about the people.

In your responses, admit your errors forthrightly. Don't ignore or avoid key issues, especially ones that multiple reviewers brought up.

Finally, be civil and thankful the reviewers. They have spent considerable time and energy to give you feedback (even if it doesn't seem to you that they have!), and you should be grateful and courteous in return.

If you submit technical papers, you will experience rejection. In some cases, rejection indicates that you should move on and begin a different line of research. In most cases, the reviews offer an opportunity to improve the work, and so you should be very grateful for a rejection! It is much better for your career if a good paper appears at a later date, rather than a poor paper earlier or a sequence of weak papers.

Even small flaws or omissions in an otherwise good paper may lead to rejection. This is particularly at the elite venues with small acceptance rates, where you should aim your work. Referees are generally people of good will, but different referees at a conference may have different standards, so the luck of the draw in referees is a factor in acceptance.

The wrong lesson to learn from rejection is discouragement or a sense of personal failure. Many papers — even papers that later win awards — are rejected at least once. The feedback you receive, and the opportunity to return to your work, will invariably improve your results.

Don't be put off by a negative tone in the reviews. The referees are trying to help you, and the bast way to do that is to point out how your work can be improved. I often write a much longer review, with more suggestions for improvement, for papers that I like; if the paper is terrible, I may not be able to make as many concrete suggestions, or my high-level comments may make detailed comments moot.

If a reviewer didn't understand something, then the main fault almost always lies with your writing. If you blame a lazy or dumb reviewer, you are missing the opportunity to improve. Reviewers are not perfect, but they work hard to give you helpful suggestions, so you should give them the benefit of the doubt. Remember that just as it is hard to convey technical ideas in your paper (and if you are getting a rejection, that is evidence that you did not succeed!), it is hard to convey them in a review, and the review is written in a few hours rather than the weeks you spent on the paper (not to mention months or years of understanding the concepts). You should closely attend to both the explicit comments, and to underlying issues that may have led to those comments — it isn't always easy to capture every possible comment in a coherent manner. Think about how to improve your research and your writing, even beyond the explicit suggestions in the review — the prime responsibility for your research and writing belongs with you.

Norman Ramsey's nice Teach Technical Writing in Two Hours per Week espouses a similar approach to mine: by focusing on clarity in your writing, you will inevitably gain clarity in your thinking.

Don't bother to read both the student and instructor manuals — the student one is a subset of the instructor one. You can get much of the benefit from just one part, his excellent “principles and practices of successful writers”:

  • Correctness. Write correct English, but know that you have more latitude than your high-school English teachers may have given you.
  • Consistent names. Refer to each significant character (algorithm, concept, language) using the same word everywhere. Give a significant new character a proper name.
  • Singular. To distinguish one-to-one relationships from n-to-m relationships, refer to each item in the singular, not the plural.
  • Subjects and verbs. Put your important characters in subjects, and join each subject to a verb that expresses a significant action.
  • Information flow. In each sentence, move your reader from familiar information to new information.
  • Emphasis. For material you want to carry weight or be remembered, use the end of a sentence.
  • Coherence. In a coherent passage, choose subjects that refer to a consistent set of related concepts.
  • Parallel structure. Order your text so your reader can easily see how related concepts are different and how they are similar.
  • Abstract. In an abstract, don't enumerate a list of topics covered; instead, convey the essential information found in your paper.
  • Write in brief daily sessions. Ignore the common myth that successful writing requires large, uninterrupted blocks of time — instead, practice writing in brief, daily sessions.
  • Focus on the process, not the product. Don't worry about the size or quality of your output; instead, reward yourself for the consistency and regularity of your input.
  • Prewrite. Don't be afraid to think before you write, or even jot down notes, diagrams, and so on.
  • Use index cards. Use them to plan a draft or to organize or reorganize a large unit like a section or chapter.
  • Write a Shitty First Draft™. Value a first draft not because it's great but because it's there.
  • Don't worry about page limits. Write the paper you want, then cut it down to size.
  • Cut. Plan a revision session in which your only goal is to cut.
  • Norman Ramsey's advice , excerpted immediately above .
  • “Hints on writing an M.Eng. thesis” , by Jeremy Nimmer
  • my notes on reviewing a technical paper , which indicate how to recognize — and thus produce — quality work
  • my notes on choosing a venue for publication
  • my notes on giving a technical talk : a talk has the same goal as a paper, namely to convey technical ideas
  • my notes on making a technical poster
  • Ronald B. Standler's advice on technical writing
  • Dave Patterson's Writing Advice
  • Advice on SIGPLAN conference submissions (at bottom of page)
  • The Elements of Style , William Strunk Jr. and E. B. White, is classic book on improving your writing. It focuses at a low level, on English usage.
  • Style: Toward Clarity and Grace , by Joseph M. Williams, is another general-purpose writing guide, with a somewhat higher-level focus than that of Strunk & White.
  • The Sense of Style: The Thinking Person's Guide to Writing in the 21st Century , by Steven Pinker, is an excellent guide to writing. It gives reasons (from psychology and other scientific fields) for its advice, making it more authoritative than someone's opinion.

Back to Advice compiled by Michael Ernst .

Logo Acadecraft

Professional Writing Services at an affordable price. Get assistance from our experts for best writing help.

Enhance user experience effortlessly!

Sign up today for FREE Website Accessibility Audit.

wave line

Section 1: Choosing Your Topic

Section 2: literature review, section 3: structuring your paper, section 4: peer review and feedback, section 5: editing and proofreading, section 6: references and citations, section 7: submission and publication, research papers made easy: a comprehensive writing guide.

Acadecraft

  • Read in 07 mins
  • 26-Oct-2023

how to write a technical paper'

Writing a technical or research paper can be both a tricky and enjoyable experience. It's an essential skill for researchers, scientists, and academics, as it allows you to communicate your findings and contribute to the world of knowledge. However, the question that arises is: How to write a technical paper?

The method of writing a technical paper can be complicated if you don't have a specific structure and plan in place. We will guide you through the fundamental elements and tips to help you write an effective research paper in this step-by-step guide. Whether you are a skilled writer or just starting, having a well-defined structure is key to maintaining clarity and coherence in your technical or research paper.

The first step in technical paper writing is to choose a topic that is interesting as well as relevant to your field of study. Consider the current trends and advancements in your field, and identify a topic that you are passionate about and have a good understanding of. It's important to choose a topic that is neither too broad nor too narrow, as this will facilitate thorough research and analysis.

The Significance of a Well-Chosen Topic

The journey to writing a successful research paper begins with selecting a topic. This initial step is crucial as it shapes the entire research process. Two primary factors should influence your choice:

1. Your Interest

When you are genuinely interested in a topic, you are more likely to dedicate the time and effort needed to explore and analyze it thoroughly. Passion for your chosen topic is a driving force in research. It keeps you enlightened and committed throughout the writing process. Research is a long-haul commitment, so make sure you're passionate about the subject you're about to delve into.

2. Relevance and Significance

Select a topic that's relevant and significant. Your paper's impact largely depends on the relevance of the topic to your field of study or area of interest. By selecting a topic that aligns with your field of study or area of interest, you can contribute to the pre-existing body structure of knowledge and make a valuable contribution to your academic community.

3. Finding Your Research Question

Once you've identified your area of interest, you need to narrow it down to a specific research question. Your research question should be clear, concise, and researchable. It acts as the guiding star throughout your research journey.

A well-crafted research question will help you focus your efforts and ensure that you gather relevant data and information. It should be specific enough to provide meaningful results but broad enough to allow for exploration and analysis.

Bonus Read: Exploring the 11 Types of Technical Writing

The literature review serves multiple purposes, including providing a comprehensive understanding of the present condition of details in your field, identifying gaps or inconsistencies in previous research, and informing the development of your research question.

The Foundation of Your Research

A thorough literature review is required before carrying out your research. This step involves exploring existing work in your field, understanding the landscape of your chosen topic, and identifying gaps in knowledge. For example, let's say you are researching the effects of social media on mental health among teenagers.

In your literature review, start by examining existing studies and theories on both social media and mental health. You may find that there is a significant amount of research on the negative impacts of excessive social media usage, such as increased anxiety and depression among teenagers.

However, during your review, you noticed a gap in the literature regarding the possible positive effects of social media on mental health. This observation leads you to develop your research question: "What are the potential positive effects of using social media for promoting mental health among teenagers?"

From this example, a thorough literature review not only helps you understand what has already been studied but also identifies gaps in the existing research. This research question opens up new possibilities for exploring how social media can be utilized as a tool for promoting mental well-being among teenagers, potentially leading to innovative interventions and strategies in this area.

A well-organized structure is the backbone of a research paper. It helps convey your ideas clearly and logically. A typical structure comprises:

Introduction

  • Research Question: Clearly state your research question.
  • Objectives: Mention the objectives of your research.
  • Significance: Explain the significance of your research topic.
  • Structure: Outline the structure of your paper.

Literature Review

  • Existing Work: Summarize and analyze relevant literature.
  • Identified Gaps: Highlight the gaps that your research addresses.
  • Framework: Provide a conceptual framework for your research.

Methodology

  • Data Collection: Describe the methods used to gather data.
  • Participants: Provide information on your study's participants (if applicable).
  • Ethical Considerations: Explain ethical considerations.
  • Data Analysis: Describe the methods used for data analysis.
  • Data Presentation: Present your research findings using tables, graphs, or other visual aids.
  • Statistical Analysis: If necessary, use statistical analysis to support your findings.
  • Interpretation: Understanding the results in the context of your research question.
  • Implications: Discuss the implications of your findings.
  • Limitations: Acknowledge the limitations of your research.
  • Future Research: Suggest areas for future research based on your findings.
  • Summary: Summarize your main findings.
  • Contributions: Emphasize the contributions your research makes.
  • Final Thoughts: Conclude with your final thoughts on the research.

Simple and easy-to-understandable writing is necessary. Avoid complex, convoluted sentences that may confuse readers. Simplicity enhances comprehension. Make use of graphs, charts, and tables to present data effectively, enhancing reader engagement.

Seeking feedback from fellows, mentors, or professors is invaluable. Peer review ensures the quality of your paper and helps identify areas for improvement. During the research paper writing process, it is crucial to engage in peer review and seek feedback from peers, mentors, or professors.

This step is essential as it helps ensure the quality of your paper and allows you to identify areas that need improvement. Incorporating feedback from others not only enhances the overall quality of your writing but also helps you gain a fresh perspective on your work. By soliciting input from others, you can address any possible weaknesses or gaps in your argument, ensuring that your paper is comprehensive and well-rounded.

Editing and proofreading are the final touches that transform your research paper into a polished gem. It's essential to edit your paper for clarity, grammar, style, and formatting. During the editing process, you can also check for any inconsistencies or redundancies in your writing.

Additionally, proofreading allows you to catch any spelling or punctuation errors that may have been overlooked. By taking the time to edit and proofread your paper carefully, you demonstrate your commitment to producing a high-quality piece of work.

Some tools that can help with editing and proofreading a research paper include:

  • Grammar and spell checkers, such as Grammarly or Hemingway Editor, can catch any errors in grammar, spelling, and punctuation.
  • Style guides, such as the APA or the MLA style guides, can also be useful for ensuring consistency in formatting and citations.

This section is crucial as it allows readers to find and confirm the sources you have used in your paper. When writing a paper, it is important to avoid plagiarism by properly citing your sources in the references and citations section. It is essential to ensure this and follow the guidelines provided by the specific style guide you are using, like APA or MLA.

These style guides provide detailed instructions on how to format different types of sources, including books, journal articles, websites, and more.

  • Suppose you are writing a research paper on climate change, and you want to include a statistic from a scientific study. In that case, you need to cite the source in your references and citations section properly.
  • In the APA style guide, you would format the citation as follows: Smith, J. D., Johnson, A. B., & Thompson, C. (2019). The impact of climate change over global temperatures. Journal of Environmental Science, 45(2), 132-150. (Note: This is just an example, and the actual citation format may vary depending on the specific guidelines of the APA style guide).
  • By including this citation in your paper, readers can locate the original study and verify the information you have included. It not only adds credibility to your paper but also gives proper credit to the authors of the study.

Once your paper is polished and ready, it's time to consider submission and publication. This step is the culmination of your hard work, where you share your findings with the academic community. Each journal or conference will have its submission guidelines that you must adhere to.

For example, suppose you are submitting a paper to a scientific journal. In that case, you may be required to include an abstract or keywords and follow specific formatting guidelines. These guidelines are crucial to ensure that your paper meets the standards and requirements of the publication.

This guide discussed various steps on how to write a technical paper or research paper. It is a journey of discovery where you not only contribute to the collective knowledge of your field but also enhance your own research and writing skills.

Remember, the journey starts with choosing a compelling topic that resonates with you. The literature review lays the foundation for your research, and rigorous data collection ensures the credibility of your work. Our technical writing services can provide valuable assistance in organizing and presenting your findings clearly and straightforwardly.

  • proofreading
  • content development
  • copy editing

Mary Parker

ABOUT THE AUTHOR

Mary has extensive experience of over 5 years in writing on a wide range of topics, including healthcare, technology, science, and business. She is highly knowledgeable and skilled in researching and crafting accurate, well-structured, and engaging content. Mary is a reliable and professional writer who is always willing to go the extra mile to ensure her clients are satisfied with her work. She is committed to delivering quality content on time and within budget.

  • Previous eLearning Content Development - Future Trends 2024
  • Next How to Conduct a WCAG Audit to Assess the Accessibility of a Webpage?

You Might Like

Writing Safety Data Sheets

The Essential Guide to Writing Safety Data Sheets

Creating Safety Data Sheets (SDS) can help with this by providing details on the hazardous chemical products that may be encountered in the workplace.

  • Read in 09 mins

Standard Operating Procedures

How to Create Standard Operating Procedures (SOP) for Your Businesses ?

By implementing SOPs, businesses can streamline their operations and improve overall productivity.

how is technical writing different from writing an essay

How is Technical Writing Different from Writing an Essay

When we think of writing, we often connect it with articles, blogs or essays. But do you know there are many different styles and formats to consider while writing content?

Subscribe to our newsletter

Join our newsletter.

Stay in tune with Acadecrafts latest news and updates.

Clients Testimonials

Acadecraft's Voice-Over service was amazing! The team provided accurate and culturally relevant recordings for what we expected. They showed true professionalism and expertise. We highly recommend Acadecraft for their excellent Voiceover services.

  • Manav Malhotra
  • Sr. Manager – Operations

Collabera

Always impressed with Acadecraft's expertise! Their translation services play a vital role for our company to drive international growth within our team and clients.

  • Alex Capizola
  • Business Operations Executive

AcadeCraft's assessment content creation team was able to understand our unique requirements and created customized assessments that fit our needs. The team was prompt and professional, and the quality of their work was good.

Acadecraft have recorded several audiobooks for us. They have a wide range of talented artists with different accents who really bring our stories to life. Their work is of high quality, with good attention to detail.

Acadecraft are reliable, efficient and friendly. Their services are highly recommended by us.

  • Mazlini Kirsty Louise
  • Editorial Head

As a producer, I've had the pleasure of using Acadecraft for sourcing VO and liaising with artists for several film projects. They offer a wide range of VO profiles and the artists I have collaborated with all were talented and professional. The team at Acadecraft have supported me with great professionalism, responsiveness and creativity. I highly recommend their services.

  • Katia Hérault
  • Head of Production

Acadecraft has been helpful with connecting our editorial team with subject matter experts (SMEs) who help us QA assessments and create solutions for computational assessments. They have been able to find SMEs to meet our needs and our deadlines. We are happy to continue to partner with Acadecraft.

  • Managing Editor

Acadecraft team is always very supportive, and we and Acadecraft corroborate to create educational contents for K12 Students in India.

We appreciate Acadecraft teams' professionality, punctuality, creation skills in each subject.

  • Mikiko Matsuoka
  • Content Manager

I am thrilled to share my testimonial for Acadecraft which creates interactive and engaging content. Working with this team has been an absolute pleasure from start to finish. Not only did they create outstanding content for our project, but they also went above and beyond to ensure that it was interactive, engaging, and effective.

Throughout the entire process, the team was highly cooperative and communicative, always available to resolve any issues or concerns that arose. They truly made us feel like partners in the project, and their dedication to delivering high-quality content was evident in every interaction.

Thanks to their exceptional work, our project was a huge success, and we couldn't be happier with the results. I highly recommend them to anyone looking for a team that is passionate, professional, and committed to excellence. Wishing them all the best in their future endeavors.

  • Hemika Kumar
  • Ed-Tech Program Lead

ViewSonic

The team at Acadecraft has truly been an end-to-end service provider for us, providing content development services and their commitment, attention to detail and expertise have made the project a success. Their team's dedication, attention to detail, and expertise have been unmatched, making our partnership an absolute pleasure. We highly recommend Acadecraft to anyone looking for a reliable and efficient education solutions provider.

  • Yogesh Malhotra
  • Senior Manager Team - Program Management

Our experience working with Acadecraft has been great. Their highly knowledgeable team of experts was always available to answer our questions, provide guidance, and ensure we were delighted with the services. Their thorough, accurate assessments provided valuable insights that helped us make informed decisions about our exam performances.

We look forward to continuing our partnership with Acadecraft and leveraging their expertise to help us achieve our business goals.

  • Sohail Ahmed
  • Senior Manager

I recently used Acadecraft's Video Editing services and I am extremely impressed with the quality of their work. The team at Acadecraft was highly professional, attentive and skilled in delivering my company’s project on time and within budget.

Their attention to detail was impeccable, and they understood my needs and requirements very well. They were able to create a video that not only met my expectations, but far exceeded them.

Throughout the process, they kept me informed and updated on the progress of the project, and were always available to answer any questions I had. Their customer service was excellent, and they were always friendly and easy to work with.

I highly recommend Acadecraft's Video Editing services to anyone who is looking for a high-quality and professional video editing experience. They are truly experts in their field and I look forward to working with them again in the future.

  • Senior Executive

The video creation team of Acadecraft is insightful. They understood my requirements carefully and delivered a winning video that perfectly aligned with my business needs.

With a good script, content, sound, and editing – Acadecraft helped me with the best video content to strategize my marketing and promotional campaigns. Their tremendous experience in video editing and professionalism in serving the customer before and after delivering services are commendable.

The passionate team knows great about getting into the details and providing impeccable video services. I am extremely impressed by the work Acadecraft has delivered to me.

I appreciate my collaboration with Acadecraft and look forward to availing of services again.

  • Ganesh Sonawane
  • Founder & CEO

I required an explainer video for my business, and I am mesmerized by the work Acadecraft’s video editing team delivered to me. The perfectly aligned video elements and superb editing demonstrate the experience, knowledge, and professionalism Acadecraft has.

Acadecraft’s 3d video solutions are amazing. They used a perfect blend of art, color, shape, sound, and editing to create the video, making the video engaging and immersive.

I have always been excited to explore the opportunities of videos in business, and it was my pleasure to make Acadecraft my companion for the best video solutions. I highly recommend this organization and would love to collaborate with them again.

With a holistic approach to creating powerful blended videos, Acadecraft delivered me a well-developed video solution. I appreciate the relentless efforts of the video editing team, whose in-depth knowledge and analytical skills effectively catered to my needs.

The services Acadecraft has given me exceeded my expectations; the team was effective and listened to my requirements carefully, and went the extra mile in researching and creatively developing awesome pieces of video content.

Not only from a quality perspective but on the management and delivery front, Acadecraft’s services are prolific. They stuck to the turnaround time and were constantly in touch with me throughout the creation process.

I recommend Acadecraft for video solutions as they have great hands-on use of animation, graphics, and other creative assets.

  • Shweta Patidar

I am thoroughly astounded by Acadecraft's proficient skills! Their exceptional voiceover and translation services were instrumental in amplifying our marketing endeavors and video promotions. They enabled us to communicate effectively with varied audiences and significantly propelled growth across numerous media platforms.

  • Sparsh Verma
  • Marketing Strategist

Working along with Acadecraft has been an exceptional journey. Their meticulous attention to detail and commitment to maintaining the essence of the content in the transition from English to Arabic was truly impressive. The collaborative spirit and timely communication made the entire process smooth and enjoyable. Without a doubt, I wholeheartedly endorse their services for a remarkable translation experience.

  • Yashashwini V Rathod
  • Account Director

changingtree

Grab a FREE Accessibility Audit Today!

accessibility

Expand your website reach.

accessibiity for website

Library Home

Technical Writing

(28 reviews)

technical writing academic paper

Annemarie Hamlin, Central Oregon Community College

Chris Rubio, Central Oregon Community College

Copyright Year: 2016

ISBN 13: 9781636350653

Publisher: Open Oregon Educational Resources

Language: English

Formats Available

Conditions of use.

Attribution-NonCommercial-ShareAlike

Learn more about reviews.

Reviewed by Amine Oudghiri-Otmani, Instructor, Marshall University on 10/15/22

This text offers a good amount of instruction (though at times limited) underlying effective workplace and technical writing/communication. Having personally examined a number of technical writing materials, this is by far one of the very few... read more

Comprehensiveness rating: 4 see less

This text offers a good amount of instruction (though at times limited) underlying effective workplace and technical writing/communication. Having personally examined a number of technical writing materials, this is by far one of the very few texts that incorporate a section about texting. Freshman students will benefit from this introductory-level text and will appreciate the authors' emphasis on conventional technical documents including emails, letters, memos, reports, and proposals. The textbook, however, may not satisfy the needs of students in advanced technical writing courses looking for guidance on complex documents beyond the conventional ones identified here. Visual representation of information could be improved, and the organization of chapters could be more strategic. A separate section about reports with important introductory information, for instance, could precede the progress reports and technical reports sections.

Content Accuracy rating: 2

A full citation guide is not provided, which may not reflect well on the credibility of the authors and/or the accuracy of the information provided. The attribution information at the end of each chapter is the only reference provided, contradicting the authors' recommendation to support one's writing with material from outside research.

Relevance/Longevity rating: 4

Although the materials are relevant to orthodox technical writing contexts, the text could benefit from a separate section that introduces writing in the digital world to reflect the evolving nature and changing landscape of technical communication. As part of the additional section, for instance, the authors could discuss potential similarities/differences between documents produced traditionally (e.g., pencil and paper, in addition to those developed by means of regular Word processor) and those produced digitally using various contemporary media. Similarities and/or differences could be discussed in light of prose and rhetorical strategies, among others.

Clarity rating: 5

The authors use simple, clear, and easy-to-understand prose. After all, sentence structure in technical writing is expected to be short, concise, and to the point. This text fits under this category of direct and unambiguous language. In addition to the authors identifying and covering essential technical terminology, the reader will appreciate the combination of descriptive (i.e., regular declarative) and direct (i.e., imperative, instructional) language. The memo, for instance, "has a header that clearly indicates who sent it and who the intended recipients are," and the reader is asked to "always consider the audience and their needs when preparing a memo."

Consistency rating: 4

Consistency is off a few times throughout the text. At the beginning of the first chapter, "Professional Communications," for instance, the authors write, "From text messages to reports, how you represent yourself with the written word counts." In this first chapter, however, only texting, emails, memos, and letters are discussed. Reports are mentioned only briefly under the cover letter to a technical report section, but no prior background about reports is provided.

Modularity rating: 5

Consistent use of headers and special highlights (e.g., boldface, etc.) helps chapter sub-sections and other important information stand out. The headings and sub-headings minimize potential distractions or other inconsistencies in modular presentation of chapter content.

Organization/Structure/Flow rating: 3

Chapter organization throughout the text consists of introduction and discussion. A conclusion in which a general, targeted final reflection is provided, however, is missing. Although the same chapter structure is used throughout the text, which will help keep the reader focused as they navigate subsequent chapter content, the authors could discuss chapter presentation, structure, and framework prior to the first chapter. The introduction section could benefit from a few sentences previewing this across-the-board structure.

Chapter lineup could also be more strategic. The chapter "Ethics in Technical Writing," for instance, could go first before "Information Literacy" and "Citations and Plagiarism."

Interface rating: 4

Readers may be distracted by the number of blank pages at the end of chapters. Readers looking to print individual chapters with ample text on each page (or those simply interested in saving trees by minimizing the number of pages printed in multiple jobs) may be disappointed. Text navigation and individual chapter selection, however, are made easy thanks to the hyperlink attached to each line/item under "Contents." Readers looking to go to a specific chapter do not need to engage in much scrolling and are given the opportunity to jump straight to the specific chapter or chapter sub-section by clicking the link.

Grammatical Errors rating: 4

No grammar errors have been detected. The authors' occasional use of the "conversational" tone may not be an issue, especially in terms of deciding whether the language matches the universal, agreed-upon conventions of technical writing. The textbook being an introduction to technical writing is meant to provide a general overview of the field, and technicality at the clause level is not required. The latter is expected to be a feature of advanced-level texts. The authors, however, could consider adding a separate section that discusses style and tone (in addition to orthodox grammar/sentence structure error patterns like splices, fragments, etc.). That the language used in the text may not match the conventions of technical writing - in terms of style and tone - could also be emphasized.

Cultural Relevance rating: 5

Chapter 13, "Communicating Across Cultures," introduces the reader to the importance of considering the variety of cultures and culture uniqueness (and peculiarity) in technical communication, which I believe does the job. Advanced-level texts may delve deeper into the requisite component of culture and culture sensitivity in both drafting certain technical documents and deciding on the style/tone to be used, context dependent. This textbook subscribes to the general/introductory category in this (i.e., discussion of culture) respect.

Reviewed by Sylvia Hayes, English Instructor, Midlands Technical College on 7/26/21

This book is concise and covers an array of Technical Communication topics and genres. This text provides flexibility in the fact that it focuses on Technical Communication for a more generalized audience and therefore this would work well as a... read more

This book is concise and covers an array of Technical Communication topics and genres. This text provides flexibility in the fact that it focuses on Technical Communication for a more generalized audience and therefore this would work well as a Technical Communications text for a First-Year Writing course at a 2 or 4-year college. The organization of the section is not very logical, luckily most instructors do not use textbook chapters in order. The text could use more examples for students in the medical and legal fields. It could use more visual support within the chapters.

Content Accuracy rating: 4

The information presented in this text is accurate, error-free, and unbiased; however, there are no references to original sources for most of the content.

Relevance/Longevity rating: 5

The content of this text is written so students can use the information in many different technical communication settings.

Clarity rating: 4

The text is clear, the prose is accessible and it defines and provides adequate context for concepts college-level students may find unfamiliar. There are multiple instances of the text directing you to a hyperlink to another resource that explains the concept in more depth. However, the text does not model the level of clarity necessary for technical communication. There are various sections that are underdeveloped and need more graphics and examples.

Consistency rating: 3

Due to the sheer number of contributing authors, it is hard to create a consistent framework for the chapters. They each seem to be designed by the separate contributors in ways that make sense to them and are not uniform to the book. In terms of terminology, the text is consistent.

Modularity rating: 3

This text is broken up into sections and subsections, that can be assigned at different points within a course. As the organization of the chapters is chaotic, I believe most instructors would have to move sections around as assign them individually instead of starting at chapter 1 and working through the textbook.

Organization/Structure/Flow rating: 1

The organization of chapters is confusing. Why are citations in between Proposals and Progress Reports? Chapters refer to students learning of concepts found later in the textbook.

Interface rating: 2

Not all sections are set up the same, which makes it harder to navigate and find information. In some versions of the text, you can't see the graphics. You cannot search the text using normal search indicators "AND," "NOT," etc. this makes searching this text much more difficult than some others. Why are there so many blank pages in the PDF, if someone was to print the text they would waste about 1/4 of the pages.

Grammatical Errors rating: 3

There weren't any noticeable grammatical errors. The sentence structure is varied, however, there were some long, wordy, confusing sentences. The tone is very casual and not professional.

Cultural Relevance rating: 3

There is no culturally insensitive or offensive language in the text, however, the text is not inclusive of a variety of races, ethnicities, and backgrounds in its examples or images.

Reviewed by Mary Larsen, Instructor, Pittsburg State University on 5/14/21

This textbook highlights important components of technical writing, including various forms of technical writing in the workplace and also approaches to audience analysis, graphics, and ethics within the writing of these documents. This text also... read more

Comprehensiveness rating: 5 see less

This textbook highlights important components of technical writing, including various forms of technical writing in the workplace and also approaches to audience analysis, graphics, and ethics within the writing of these documents. This text also includes information about resumes and employment, which is very applicable to technical writing and provides readers with a dual layer of content.

Content Accuracy rating: 5

Content within this text is accurate and mostly error-free. The content is based off of multiple authors rather than one single-viewpoint, which provides additional insights into topics versus only one limited view. Content is cited and derived from David McMurrey, who has experience and a plethora of knowledge in all aspects of technical writing.

The text is relevant to writing in the workplace as it covers aspects of "netiquette," which is something technical writers will encounter more and more as workplace functions are moved more to online formats. The formats covered are also frequently used forms of communication in the workplace, such as email, letters, memos, proposals etc. This provides a large scope of relevant documents that readers could encounter when writing in the workplace.

This text is written in plain language and easy to read. Content is sectioned off pretty well for easier readability and there were few, if any, areas of jargon or overly technical language. Tips are provided in various sections that assist readers in actually applying the content.

Consistency rating: 5

How text and visuals are presented and the sense of organization of various chapters and sections are all consistently presented within.

Modularity rating: 4

Subheadings are used within for easier readability; however, content is text-heavy at times. Content jumps around some, but is otherwise organized into a logical progression of points (such as discussing audience and types of documents in the beginning and saving design and employment content for later in the text).

Organization/Structure/Flow rating: 5

The organization follows a logical progression of ideas and concepts that would be presented within a technical writing course. The Table of Contents includes easily recognized sections and page numbers and each new section is noted at the top of the page. At times the images presented conflict with the text and spacing on pages, but is otherwise easy to attribute to the content pertaining to the image.

Interface rating: 5

Some of the images / videos are pixelated. The textbook includes links to videos and images that further touch upon the concepts of a chapter, which is very helpful and engaging. Images link to direct PDF files for easier access of a document. Seems to be some unnecessary space left on pages or between section changes.

Text is mostly free of grammatical errors, although a few minor grammar mistakes were present. For example, "insure" is used instead of "ensure" in Section 3.7.

Chapter 13 of the text is "Communication Across Cultures," which lends to its response to cultural sensitivity. The text seems to keep in mind readers of various races and backgrounds and uses relevant pop culture references that are inclusive. If anything, the textbook could incorporate aspects of gender in relation to technical writing in the workplace.

This textbook covers most all of the content I currently use in my own technical / professional writing courses and I am considering adopting this textbook in future courses that I teach.

technical writing academic paper

Reviewed by Bjorn Smars, Career Instructor, University of Oregon on 7/2/20

As far as I can tell, this textbook does not include an index or glossary. However, each chapter is broken into separate sections with descriptive titles and headings, so navigating to specific concepts and ideas is not difficult without the use... read more

As far as I can tell, this textbook does not include an index or glossary. However, each chapter is broken into separate sections with descriptive titles and headings, so navigating to specific concepts and ideas is not difficult without the use of an index. My only complaint about this text, at least in regards to its comprehensiveness, is that many of the sections or pages are underdeveloped or do not contain sufficient explanation and/or examples to illustrate important concepts. For example, the chapter on communicating across cultures provides useful tips that students can use to think critically about cross-cultural communication, but these suggestions are limited in that they are designed to apply broadly to most situations in which cross-cultural communication occurs and therefore do not offer clear guidelines or practical strategies for students to learn about and identify a particular culture's communication norms.

As far as I can tell, the information presented in this text is accurate, error-free, and unbiased. The purpose of this textbook is to serve as an introduction to technical writing, and as such is designed to provide students with practical strategies for engaging in effective technical communication.

As I mentioned in an earlier comment, most of the content in this textbook is written in such a way that it can be applied practically and broadly to a variety of situations in which students may find the need to engage in technical writing and/or communication. The focus is more on providing practical strategies and helping students develop critical thinking skills than it is about using a particular software.

The prose is clear and accessible to college-level readers, and unfamiliar concepts are either defined in-text by the textbook's authors or via hyperlink to another source. For example, in chapter "13.2 Understanding Cultural Context," the authors provide a link to a YouTube video that explains the differences between high-context and low-context cultures in more depth.

The textbook uses consistent terminology and frameworks throughout.

As I mentioned in an earlier comment, the organization of the textbook is easy to navigate and understand. Each chapter is broken into separate sections with descriptive titles and headings. My only complaint is that there is some inconsistency between the lengths of each chapter's subsections. Some sections are very short (150-300 words max) while others are much longer, ranging in the 2,000-3,000 word range. That said, each section is clearly labeled, and the headings are highly descriptive.

See previous comment.

Each chapter's subsection has navigational arrows that allow the reader to move on to the next section easily, and the table of contents is easily accessible on every page. However, locating the table of contents may not be intuitive for some students, and some students may not know how to navigate through each chapter's subsections.

Grammatical Errors rating: 5

I did not notice any grammatical errors.

Cultural Relevance rating: 4

As I mentioned in an earlier comment, this text could provide more examples to help students better understand cultural differences in terms of communication. More examples that are relevant to students attending one of Oregon's many colleges or universities would help to illustrate these cultural differences and provide students with a practical, real-world strategies for engaging with their peers, professors, and other folks from other cultures and/or regions.

Overall, I found this textbook very useful, though I had to supplement much of the information either with links to other sources or with material I developed personally. It's a useful and accessible introduction to technical writing for most undergraduate students, but it is not a comprehensive document and therefore may require the instructor to provide additional information or resources.

Reviewed by Elizabeth Aydelott, Part-Time Instructor, Lane Community College on 6/26/20

This text covers almost every topic that I would cover in a Technical Writing Class for generalized studies. A class geared toward a specific aspect of the field - engineering or a medical field, for example - would need to add material. This text... read more

This text covers almost every topic that I would cover in a Technical Writing Class for generalized studies. A class geared toward a specific aspect of the field - engineering or a medical field, for example - would need to add material. This text provides a solid basis for any course in technical writing, though.

The information is accurate, the citation guide up-to-date, and most material is relevant to any aspect of the field.

The content is almost all up-to-date. I would suggest adding a section on conference calls in the chapter on Professional Communications. That format has its own specific netiquette rules, ethics, and audience considerations. And conference calls, in a variety of formats, are increasingly essential to the working life.

Clear, common sense prose. The beginning of each chapter should probably be titled "Overview" or something similar, perhaps with a brief outline, for more clarity.

The book's structure changes with each format. I suggest that the instructor designate a preferred version for the class. Within the text, however, it becomes fairly easy to navigate through the material.

This text would be easy to assign in appropriate chunks for the students.

The text has a logical order, but I would assign the last chapters first since I usually begin with employment application materials and then cultural awareness almost immediately afterwards.

Interface is fairly straightforward and clear. Some of the videos, particularly in the beginning, are a bit referential to a specific course rather than to the topic in general.

Grammar has no problem. I wish, though, that a general chapter on grammar was included for the students.

I really appreciated the chapter on Communicating Across Cultures, but I wish it had been included earlier in the book. Perhaps a reference to Cultural Literacy within the chapter on Audience.

I'm confused about why the Open Textbook Library lists the book with only one author instead of the seven listed in the book itself.

Reviewed by Christopher Schott, Assistant Teaching Professor, University of Missouri - St. Louis on 4/23/20

This book really does cover a great deal of ground. However, I found the pacing and the organization of the section to be a little sporadic, especially if the book were to be read linearly by students. This may not be a serious concern as,... read more

This book really does cover a great deal of ground. However, I found the pacing and the organization of the section to be a little sporadic, especially if the book were to be read linearly by students. This may not be a serious concern as, especially in a digital format, the book can be navigated easily from topic to topic. Many chapters are short (some are quite detailed, though), which can be a real asset, but the lack of technical writing theory might be a concern for instructors looking to balance practice with understanding approach. While the book does cover a great of texts that are useful for students studying engineering and computer science, it may provide fewer examples and cover less in terms of students looking for technical communication instruction in medical fields, journals, legal fields. Another issue, when it comes to comprehensiveness, is the lacking of exercises and assignments. For my own teaching, this is not an issue (I try to craft assignments that fit the culture of my students' academic programs), but I could see it limiting the use of this book for other professors who would like corresponding assignments and readings.

As a reader, this book seems unbiased to me. That said, there are some prescriptive outlooks on crafting documents that may lead a reader to believe there is a one-size-fits-all way to compose a text. For example, there is a recommendation that emails are limited to three paragraphs, which is a very narrow view of that genre (shouldn't it depend on the rhetorical context, audience, etc.?). Overall, the content in the book appears accurate, even if a little prescriptive at times. However, this can be remedied through instruction from the professor.

The information that is presented in this book is very similar (and in some cases, exactly the same) as the information I've been teaching for the ten years I've been teaching technical communication. Some concepts in this course, such as audience, purpose, tone, precision--these will forever be touchstones of any professional writing course, technical writing is no exception. I very much am happy to see a chapter on information literacy, which is honestly and unfortunately absent from a surprising amount of existing (and expensive) technical writing textbooks. Some of the information does seem to not work (some links, for example), which may hurt longevity, but the authors do note this might be a possibility when using the book.

This book is clear. As a technical communication text, I would hope it would be and I was happy to see the authors not utilize jargon, instead stick to very explicitly presented ideas, sentence structure, and offering simple language that will appeal to readers, make them feel smart, all while retaining the level of academic rigor a text like this needs.

The chapters in this book are all formatted relatively the same. This offers readers a consistent and predictive reading experience (which, in itself, is a valuable technical communication skill). Each chapter starts with a very useful introduction, leading nicely into the rest of the chapter. There are, at times, inconsistencies in how thoroughly topics are treated and covered, but that is to be expected with many textbooks.

This text seems to be designed for purposeful fragmentation in a course. By this, I mean that the text does not have to be read linearly to be useful for students. In fact, and this is something the authors may have had in mind when writing, but most textbooks are not read and interacted with linearly anyway. Chapters are skipped, brought back, and revisited. I think this is just fine and, in many ways, provides a more fruitful reading experience.

Along with the previous idea of Modularity, I do not think the text is perfectly organized. One could argue that a textbook should move from more simple to more complex concepts. However, I disagree and do not think this needs to be the case. Instead, while the chapters here might seem a bit out of order in terms of their "difficulty," to do seem to be ordered nicely in terms of some theoretical understanding (though, very little) into more genre-based writing. Because the text can function in ways that benefit the class, this is not an issue.

The book is incredibly easy to navigate and use. Some links are broken, which can be frustrating, but it doesn't distract from the usefulness of the book overall.

I did not notice any grammar and mechanical errors in the text.

Despite an opening comment in the Introduction that claims students will learn to write "in such a way that even Grandad can understand," a which is a bit insulting to grandpas everywhere (it's ageist), the book seems to be culturally respectful and appropriate. I am a big fan of the cultural sensitivity section in the book, which I think is very carefully and thoughtfully presented to readers. There are topics that can be included that were not. In technical communication, it's important to remember that standards are always changing in business and this will undoubtedly shift the way professionals communicate, interact, and write. For example, a section on language inclusivity would be useful.

I'm grateful for this book. The authors have really put together a text that is useful in terms of what it can do in different kinds of technical communication classroom. I've seen many different kinds of technical writing courses and they are all taught differently. It seems this book has the unique ability to fit many different kinds of teaching styles, learning environments, and student abilities--and the book's design and functionality allows for professors to be very malleable in their pedagogy.

Reviewed by Brian Ballentine, Professor, West Virginia University on 4/20/20

The book is being reviewed the book in the web PDF format. At least one other reviewer has noted that there are inconsistency issues across various formats in which the book is offered. The web PDF format functions as expected in Acrobat reader... read more

Comprehensiveness rating: 2 see less

The book is being reviewed the book in the web PDF format. At least one other reviewer has noted that there are inconsistency issues across various formats in which the book is offered. The web PDF format functions as expected in Acrobat reader with the sidebar thumbnails and toc providing hyperlinks to specific pages and sections. This format does not have a much-needed index or glossary. The book does not have the same comprehensive content that a student would find in one of the large, mainstream, and admittedly costly technical communication texts by authors like Markel and Selber, Lannon and Gurak, or Anderson. There isn't enough or any coverage on important topics like instruction sets, technical procedures or definitions, user experience testing (including testing instruction sets and other technical documentation), and oral presentations. Documents like instruction sets are mentioned but only in passing. E.g., "Examples are one of the most powerful ways to connect with audiences, particularly in instructions" (2.3). There is content on preparing PPT slides but no content on giving a presentation.

The content does not cite original sources. Each chapter and even sub-section has author attributions for the book itself but rarely does it reference external sources. This becomes particularly obvious for writing instructors in parts of the book like chapter 14 that contend with genre, genre analysis, and genre systems but with no references to the writing scholars we attribute to genre studies (Miller, Bawarshi, Russell). This is not to say that the content is automatically inaccurate but one of the points the authors themselves make about the need to cite sources is the importance of using those sources to build confidence in the audience.

Relevance/Longevity rating: 1

The book opens with content on texting and email but then largely abandons digital communication platforms. Again, in larger technical communication textbooks instructors would expect to find chapters dedicated to "blogs, wikis, and web pages" and "social media" platforms as in offerings by Lannon and Gurak. A more contemporary text would no doubt include online collaborative tools and meeting platforms like Slack and Microsoft Teams. The recommendation here would be to create a separate chapter or chapters dedicated to technology platforms with the idea that it would be easier to update in the future.

Clarity rating: 2

The writing is more conversational than professional. The book does not model the level of clarity needed for technical writers. E.g., section 9.2 on "Presentation of Information" begins with a longer paragraph that attempts to summarize the space shuttle Challenger disaster as an example of why clear communication is important. The textbook authors write: "Possibly the engineers were just poor writers; possibly they did not consider their audience; or possibly they did not want to look bad and therefore emphasized all the things that were right with the Challenger. (Incidentally, the O rings had worked fine for several launches.)" Edward Tufte's now famous case study of the Challenger contradicts this summary. The rocket company and its engineers did indeed make a no launch recommendation (their first in 12 years) precisely because they had data showing the O-rings failed in cold temperatures. It is moments like these in the textbook that give me pause.

Consistency rating: 2

The multiple authors on this textbook likely pose challenges for creating consistency across the project. For example, in the chapter dedicated to Proposals, the first section is titled "Some preliminaries" and it offers a narrative overview of proposals and the roles they may play. In the chapter dedicated to "Progress Reports," the first section offers "functions and contents of progress reports" that has just two bullet lists. Students like to become acquainted with a consistent format across a book's chapters so they know where to find answers/resources that they need, regardless of the topic.

The textbook does contain self-referential content but overall the chapters could be used in a modular fashion to supplement other learning materials/readings in a technical writing course.

Organization/Structure/Flow rating: 2

Even if the textbook was designed to be modular, it is still prepared and presented in a specific order (with linked toc in the PDF version). Concepts of genre and genre analysis are presented as fundamental to understanding the writing process yet they come at the end of the text. Audience analysis comes much earlier (chapter 2) but not before texts, emails, and netiquette. Proposals are in chapter 3 but information literacy, including instruction on how to begin research for a proposal isn't until chapter 4. Organizing a textbook toc must be incredibly challenging but there are many models out there that overcome some of these organizational challenges.

Interface rating: 3

The PDF version of the textbook works as expected in terms of the links in the toc and the thumbnails visible in Acrobat. It can be challenging to orient yourself in the text especially because there are many pages with minimal content. The PDF version has 242 pages but I would recommend to students that they only print selectively as many pages are blank.

Despite having many authors (and some open source content), the book does not have an abundance of grammatical errors. As mentioned before, the more casual tone of the textbook does not help with modeling technical and professional communication. There are grammatical issues (or perhaps more stylistic issues) that could be edited. E.g., the book uses the opening phrase, "In other words..." ten times throughout the book. Overall, though, the book scores high in the grammatical category.

Chapter 13 is dedicated to "Communicating Across Cultures" and offers students an overview of "culture" as a term as well as some important guidance on global communication. The book does break some of its own advice in these sections with references to authors with no attribution. E.g., "Geert Hofstede views culture as consisting of mental programs, calling it softwares of the mind, meaning each person 'carries within him or herself patterns of thinking, feeling, and potential acting which were learned throughout their lifetime.'” This chapter could make more specific references to technical communication and globalization. A longer paragraph in 13.4 on intercultural communication uses sheep as an example when there are so many ways to talk about the importance of good technical writing in support of technical products and services when they go global.

I would like to thank all of the authors as well as David McMurrey for their efforts in writing and editing this open source textbook. I will likely use chapters or sections to supplement other course materials in an effort to save students money on textbook costs. It may be possible to pair chapters from this textbook with one of the smaller "handbooks" on technical communication out there. While the ratings here aren't overly high, the standard of comparison was challenging. I am looking for options to supplant one of the large, mainstream technical communication textbooks and that is a high bar.

Reviewed by Lars Soderlund, Associate Professor of English, Western Oregon University on 3/7/19

The book has a strong balance of topics. In addition to the mix of genres that it discusses, the book is also effective in its coverage of different aspects of writing such as audience, context, ethics, etc. read more

The book has a strong balance of topics. In addition to the mix of genres that it discusses, the book is also effective in its coverage of different aspects of writing such as audience, context, ethics, etc.

The book contains no inaccuracies as far as I could tell, nor any political or social bias.

The book is relevant in a way that seems sustainable. It is not at the cutting edge of technical writing technologies or software, but it is the sort of book that would have (and probably has) helped students a decade ago and will still be useful in another decade owing to its coverage of general topics and its emphasis on writing fundamentals.

The book is extremely easy to read, and should not hold any students back.

The book's format changes occasionally, probably owing to the various authors involved, but it is not especially noticable and does not affect the book in a negative way.

The book seems to have been designed for modular use, and indeed that is how I plan to use it in my future classes. The way that the book starts with a quick reference guide to genres and then moves into the big-picture writing theory is evidence that the writers want the book to be immediately useful.

The book's organization seems maximally effective for teachers and students. As I mentioned above, the book starts by covering genres with relative swiftness, then it digs into essential writing topics, and then it covers larger genres in more detail. It ends with a section on "Thinking About Writing" that is pretty clearly designed for more advanced readers, and I think that's an effective choice.

The book was extremely easy to navigate and to use.

The book is very well-written and contains no grammatical errors.

The book is fairly dry, and so I did not notice cultural issues that might be of note.

The book is very good, and I look forward to using it.

But I do want to say that although above the book got 5-stars across the board, I'm not sure if I would give it a perfect review if I were to rate it. Basically, I find that students seem to flourish when a class (and a textbook) regularly comes back to explicitly stated themes, and the book didn't necessarily have those. They were there (audience, genre, etc.), but they weren't really up-played in a way that students will definitely get.

Still, again, this is a very strong book and I plan to redesign my future Technical Writing class with it.

Reviewed by Kathryn Northcut, Professor, Missouri University of Science and Technology on 1/13/19

The book is offered in various formats, and they aren't parallel. The organization of chapters in the web-native version defies logic. The expandable table is tricky to get used to because the hyperlink from the Chapter title goes to the chapter... read more

Comprehensiveness rating: 1 see less

The book is offered in various formats, and they aren't parallel. The organization of chapters in the web-native version defies logic. The expandable table is tricky to get used to because the hyperlink from the Chapter title goes to the chapter but the arrow on the right shows the subsections. It's hard to remember where you are as you navigate. I did not locate a glossary or index, and the book is not fully searchable in the web-native version because all sections can't be expanded onto one screen.

Content Accuracy rating: 1

Almost none of the content has references to original sources, and far too little theory is made explicit. Too much of the writing is chatty and conversational to provide a model of technical writing for university students.

The first section includes both platforms and genres. However, currently relevant platforms like Twitter are excluded from this section. Mixing platforms and genres seems odd logically. Later chapters jump between concepts and genres with no obvious logic to the order.

The style is accessible but not professional. The writing attempts to be engaging but is not rich enough in evidence, references, or good, contemporary examples for university students.

Consistency rating: 1

Unfortunately, the book consistently raises questions about whether these authors/editors have worked in technical contexts recently. Their advice seems to be off-base, including comparing omitting a conclusion to slamming down a phone on a caller. In fact, much professional writing starts with an abstract, executive summary, or cover sheet that obviates the need for a conclusion. The worst thing we can do in much scientific and technical discourse is build suspense and save the point, answer, or recommendations to the end. The way this book is designed and written does not seem to engage the exigencies of technical writing as I'm familiar with them. Other textbooks, whether consistent or not, provide better examples of practices from many industries to help prepare students from writing after college. This textbook focuses not just on the college experience, but on the Central Oregon Community College experience to the exclusion of other contexts.

Modularity rating: 2

The text does not contain modules that stand independently, despite appearing at the outset to be designed that way. Many phrases such as "as seen in the last section," make it difficult for students to follow what's happening. The videos address students in a single section writing a specific assignment and the content of the videos is not transferable to other contexts. The videos I viewed would not work in my courses, ever. Further, the textbook refers constantly to watered-down assignments that I would not assign. In my courses, students DO write a full proposal, not just an academic topic proposal. No one in industry writes topic proposals, so I would not teach that genre in my technical writing course. In fact, this textbook constantly focuses on the specific introductory assignments and methods at Central Oregon Community College, so a more ambitious, advanced curriculum would directly contradict the information in the textbook. If you wanted to teach your students to write proposals, you would be better off with online examples of successful proposals and top-of-the-head commentary than this textbook.

The organization of the textbook appears to be clear and clean, but gets difficult to manage once specific questions are asked, such as, "how should I assign readings to prepare my students for specific assignments?" One of my specializations is teaching proposals. This book doesn't handle proposal writing in a way that fits what I know of proposal writing outside of essay topic proposals used in composition courses. Why is information on Citations and Plagiarism after the chapter on proposals? Professional and academic proposals are robust documents which cite sources, so that background information would be useful earlier. Despite the textbook attempting to be modular, numbering chapters does suggest that there is a logic to the order. Non-numbered TOC might be a solution to this problem. In this book, short chapters are split up into tiny subparts, and navigation between them is tricky in the web-native version. Other Technical Writing/Communication textbooks, from Burnett's 2005 Technical Communication 5th Ed., to the current editions of Markel (and Selber) and Lannon (and Gurak) are superior in terms of internal logic, as is the Engineering Communication Manual (House et al) if the authors/editors need better examples of structure.

Interface rating: 1

I found the design appealing initially. Using it was confusing and there are many incompatibilities between the various versions available. The students would have difficulty locating the correct version of the textbook unless a PDF were provided to them by the instructor, and the PDF is problematic in terms of design and omission of content. In the web-native version, the sections are all very short and navigating to the next section requires clicking back and re-finding your place every time. Not having a "next section" button or arrow almost ensures that students will not complete the readings because they will think, incorrectly, that they are done with the (very short) chapter. The PDF version has many blank pages, making navigation cumbersome. The PDF document is much thinner than the large number of pages suggests. If a student were to print the PDF, much paper would be completely wasted and blank.

The conversational tone isn't ideal for educating students who will need to do technical writing in industry, but there are few overt typographic and spelling errors. The ones that exist are obvious and instructors can correct them if they use those chapters. Sometimes the authors refer to specific genres (like reports, in section 5.1) in a way that would confuse students (because writers cite sources in proposals, memos, and presentations, not just reports), and those errors should be addressed lest the students be misled about the conventions of the genres. Further, references to "your paper" and "paper" demonstrate lack of focus on rhetorical concepts of audience and purpose that should drive every technical communicator in every task. Most of our work is electronic/digital/online, so references to paper may not be incorrect, but they are largely archaic. When the authors refer to student assignments, they might call them "assignments," not "papers." The writing in section 5.2 needs editing. Overuse of "it" and "there" and back-referencing through pronouns ensures that students will have difficulty parsing the information. Further, students are seeing a poor example of a strong technical writing style because the sentences are written in a vague style that would lead to comprehension and translation errors. Further, the authors state that plagiarism is institution-specific, but that's only true in our academic bubble. In fact, plagiarism is an important IP (intellectual property) concern globally, so reference to international publication and copyright standards would be far more useful to students, who are students for 4 years or so, but professionals for up to 40 years.

Cultural Relevance rating: 2

Ideally, the authors would employ a plain style to avoid usability problems for non-American-dialect users. In the section (2.1 types of audiences) about audience, an opportunity is missed by not getting into user profiles and usability theory. Contrary to what is stated, technicians do not always lack sophisticated theoretical knowledge. It is not true that executives are always the audience for whom our students will or should write. The lack of robust user-based terminology is a problem with this book. I wonder if any of the authors are currently active in the technical communication community or have worked in nonacademic technical environments on communication design tasks. If they have, I would implore them to use better industry examples and the jargon of writers in technical professions. The authors should also focus on plain language in this book, and exemplify it in their prose. Karen Schriver's work is a good starting point.

I recommend this book (only) to instructors at Central Oregon Community College, where it perhaps serves a useful, important purpose. Its structure and content is unsuitable for majors in professional fields including engineering and science, and therefore is not a good choice for instructors teaching at most institutions where the course is offered. The emphasis on MLA style demonstrates the limited appeal of the textbook (to English majors). To be clear, MLA is not used in a single industrial or professional context I am aware of, outside English departments and literature-oriented professions. No mention is made of IEEE, which is the largest professional society in the world and which publishes professional ethics and authorial style guides that many professionals will encounter. It's great to include APA, but that social-science emphasis should be balanced with another professional style such as ASME or IEEE. The authors may have heard this, because they mention ASME in section 5.1, but they give no examples of what ASME looks like in practice. I worry that this textbook potentially does a disservice to the technical communication field as well as to open-access materials, which should be of high quality and represent best practices based on an awareness of the range of communication tasks working professional undertake. David McMurrey's work was far more technical and usable in its time; I'm sad to conclude that this textbook does not build productively on his legacy.

Reviewed by Jennifer Wilde, Adjunct instructor, Columbia Gorge Community College on 12/18/18

The text does many things very well, but it is too uneven to be truly comprehensive. It will work best as an introduction to technical communication and business writing. It is less helpful, I think, to students going into health care fields and... read more

The text does many things very well, but it is too uneven to be truly comprehensive. It will work best as an introduction to technical communication and business writing. It is less helpful, I think, to students going into health care fields and the social sciences. Chapters are brief and pragmatic, with no discussion of theory, no instruction on clarity or sentence structure, and little discussion of diction and style. The index is helpful; there is no glossary, but this does not seem to be an omission as there is little jargon used throughout the book. Some of the chapters are extremely brief and rudimentary, while others are detailed and nuanced. An example of the former is the section headed "Types of audiences", and an example of the latter is the section on ethics of technical writing. One of the earliest chapters is about texting. There are useful chapters dedicated to resumes, incident reports, proposals, and several other genres - and there is an interesting, though perhaps not as practical, discussion of genres in writing. Like most other technical writing resources, this book has nothing to say about case reports, medical or nursing notes, letters to the editor or position papers for professional and trade journals, all of which are pertinent to the daily work of many professionals in human services or advocacy. Another issue with the book is the lack of writing exercises and assignments. There are some areas with a "Try This" section, but not very many of them, and the assignments lack an assessment component.

The book seems unbiased, although some advice feels a little arbitrary, such as the recommendation to limit emails to three paragraphs. I do not find any errors of content. There is a technical error in the middle of the book, where the author refers to a graph about voting in Australia; that graph does not exist on the page but there is this editorial comment that was no doubt not intended for publication: [“How to vote…” – this image is on a blog that is CC-licensed but I don’t think the author used the image with permission. Is it possible to find a sub?] Who is who? Which Australian are we voting for?

Much of the advice will be appropriate forever: know your audience, know your purpose in writing, be respectful, be specific and clear rather than general and vague. The sections about how to present information visually are helpful: contrast, repetition, alignment and proximity are given the unfortunate acronym CRAP (so no doubt the reader will never forget it!) I also appreciate the chapter on information literacy, which includes information on scholarly, professional and general publications. This includes trade journals, something that WR 121 classes tend not to mention but are important for technical writing students. Of course, there is some information about PowerPoint that is likely already past its best-buy date, but the authors discuss that and point the reader towards existing and upcoming technologies other than PowerPoint. I was able to see the video on the writing situation but not all of the other links worked. The authors include a caveat that not all links will work, so that seems fair, but a comprehensive resource would not rely on links to external sources with all their potential foibles.

The authors resist the temptation to use jargon, and they stick to simple sentence structures for the most part. In that sense, they exemplify the sort of simple, crisp (if unexciting) prose that technical communication strives for. There is abundant use of the colon to introduce lists, and the authors use bullet points frequently.

The book is highly consistent. Each chapter starts with a brief introduction to what comes in the sections included in the chapter. That means that the first segment of each chapter is extremely short, followed by more detailed segments. What is not consistent is the amount of time spent on various elements of technical writing, which, as mentioned in the section on comprehensiveness, varies quite a bit.

Chapters could be read out of order, and instructors can certain assign some sections and not others. I would be most inclined to use the chapters on ethical issues, research, and proposals. I think that's OK, but the book is almost too modular. Chapters do not relate to one another and the order in which they appear feels arbitrary. There is some redundancy - for example, the issue of audience is addressed repeatedly without adding anything new on the subject. I generally prefer a text in which each chapter leads logically to the material in the next chapter and adds to the student's understanding of technical writing, but there are advantages to a source like this, too.

Organization/Structure/Flow rating: 4

The book is highly modular and the chapters do not flow into one another. I'm not sure why the chapters are ordered this way. I would tend to put some basic information about what constitutes technical writing at the beginning, followed by some guidance around doing research and writing ethically, followed by chapters on different types of technical writing: texts, emails, case reports, letters, resumes, proposals, recipes, instruction manuals, position papers, abstracts, encounter notes from a visit or interview, letters to the editor, mini-biographies and autobiographies ("about the author"), annotations. I would include an appendix about conventions: when to use a colon, how to convey numbers, the rules of capitalization, and the like.

The navigation was extremely simple and easy to use. The charts and images that are used are minimal but every one is highly useful and easy to see. Some links are broken.

I am prone to noticing grammatical and punctuation errors, but nothing jumped out at me in this textbook.

There is an ageist comment about "so easy that Grandpa could understand it" in the early pages defining technical vs academic writing. There is a very thoughtful section on cultural sensitivity. The authors use an interesting example of cultural differences, using a world map to illustrate the different meanings of the color red in different countries. However, it seems like a serious omission to leave out a discussion of inclusive language. Things in that field are always changing, but the authors could provide information about where to find the most up-to-date recommendations on inclusive language, such as the acceptability of "they" as a singular personal pronoun for gender nonbinary people, and what language is appropriate to describe ethnic groups etc.

The book is quite well written and useful, but not comprehensive. I would love to see this text updated with more sections. Chapters on lab/case reports, medical/interview notes, abstracts, introductions, mini-biographies, position papers and letters to the editor would enhance this text and broaden its appeal to new audiences, especially social science/health care students. I would love to see sections on effective sentences, collaborative writing, inclusive language, and grammatical conventions. Finally, an effective text on this topic should include assignments along with discussion of how to assess the assignments.

Reviewed by Cynthia Kimball Davis, Chair of the Integrative & Interdisciplinary Studies (IES) Department, Southern Utah University on 8/2/18

Comprehensiveness - Appears to offer all of the standard technical writing topics with an excellent easy bulleted table of contents. It also contains an excellent index and glossary. read more

Comprehensiveness - Appears to offer all of the standard technical writing topics with an excellent easy bulleted table of contents. It also contains an excellent index and glossary.

Content Accuracy - Appears to provide accurate content.

Relevance Longevity - Information appears to fit the relevant longevity category with the exception of the Professional Communication chapter; however, that would be an easy update.

Clarity - Information is presented in a simple and clear format.

Consistency - Information was not found to be incongruent in any way.

Modularity - The text is laid out in chapters with clear and simple sub-headings underneath each one.

Organization Structure Flow - The flow of the text is easy to follow.

Interface - The images could be more ascetically pleasing to the eye. In come cases, it appears that a high school student made them. Investing in a graphic designer might make the graphics more ascetically appealing. Furthermore, breaking the text apart with colorful questions and answers, activities, quotes, etc., is suggested.

Grammatical Errors - There were no grammatical errors found.

Cultural Relevance - The text appears to be culturally sensitive of all races, nationalities and ethnicities.

A text I definitely want to consider for my Technical Writing course. :)

Reviewed by Adam Karnes, Adjunct Instructor, Linn-Benton Community College on 6/19/18

The book covers the typical range of topics for a technical writing guide. At times, the balance feels off. A significant amount of the length is dedicated to topics usually covered in other classes (including research, citations, outlining). I... read more

The book covers the typical range of topics for a technical writing guide. At times, the balance feels off. A significant amount of the length is dedicated to topics usually covered in other classes (including research, citations, outlining). I would have preferred to have more info about the modes typical to technical writing, but what the book has is useful. Also, while the book has examples, I would appreciate even more examples. The book has a dropdown menu with a table of contents and a search feature in the reader.

The book is accurate. I did not observe inaccuracies.

On the whole, the book is relevant and should remain so for several years without the need for updates.

One important consideration regarding relevancy is the thematic dominance of references to Oregon. While the frequent mention of things related to the Pacific Northwest does not limit the readability of the text, this reoccurring theme makes the book more relevant for readers from this area than from others.

The book is clear and written with appropriate vocabulary for the typical student of technical writing. The body of the text goes into an adequate depth in the explanation of key concepts. Crucial terms are adequately explained. Examples are frequently included, although even more examples would be a welcome addition. The book lacks a glossary, which would also be a helpful addition.

The text is adequately consistent from beginning to end, but at times the sections feel disconnected. In this respect, the text works well as a modular book with distinct sections. The various parts do seem separate, however. The crossover between chapters could be stronger. This is probably the case due to chapters being derived from other sources. The differences do not render the text unreadable, just lack cohesive than the average textbook.

This text excels as a modular work. The sections are distinct and could be read independently. Teachers can easily pick and choose between sections without assigning the entire text.

The order in which the book’s contents are presented is somewhat arbitrary. (The section on resumes, for example, comes at the end—in many technical writing texts, this would come at toward the beginning.) Still, the ordering of the text is not confusing.

Navigating the text can be slow, with lots of scrolling and clicking through. Some of the sections are particularly long, and can be tiresome to scroll through. However, the table of contents is accurate and helpful. The book also has a search feature.

The text has no grammatical errors. The overall quality of editing is high.

The text is geared towards an American culture. However, the text discusses at length the importance of audience awareness and cultural differences in writing, particularly applications that span multiple cultures.

The greatest value this book offers is the ease with which teachers can select limited portions to assign to students based on the class objectives. This could easily replace a standard technical writing textbook in many courses, particularly if other texts further supplemented the class.

Reviewed by Susan Engel, Instructor, St. Cloud Technical and Community College on 6/19/18

Although an index/glossary is not provided, the Table of Contents organizes the material and allows for readers to see the breadth of areas and subjects within the Technical Writing textbook. Topics common to technical writing courses are explored... read more

Although an index/glossary is not provided, the Table of Contents organizes the material and allows for readers to see the breadth of areas and subjects within the Technical Writing textbook. Topics common to technical writing courses are explored in this text and include an important section (4.6) on evaluating sources as well as sections on plagiarism and the importance of citing sources. Topics that could perhaps be added to the text include social media (LinkedIn in Chapter 12: Employment Materials, for example) and technical writing for web pages or using online technologies.

Overall, the content appears accurate, error-free, and generally unbiased. Figure 13 in Chapter 11.4, however, doesn’t offer a resume sample for the exercise and simply states “Text of fake resume here”.

Content appears to be mostly relevant and offers up-to-date information on information literacy and other important technical writing concepts. Some of the content could be further updated, however. For example, chapter 12 discusses the idea of the cover letter being potentially outdated but then proceeds to offer guidance on writing one. This and other sections could offer updates, particularly regarding electronic and online documents.

The text is accessible and concise in delivery. Further clarification is offered through examples/samples in the sections on emails, memos, outlines, cover letters, technical reports, and others. Examples could be given in sections on proposals, progress reports, and other sections to offer further clarity.

The text offers consistency through the organization of the chapters and sections. Some chapters have features that others do not have, however. For example, Chapters 11 and 13 are structured with interactive activities not found in other chapters. The “activity” and “try this” in these chapters would be helpful in other chapters, too.

Chapters and sub-units within this text are clearly labeled. Although some overlap is offered, overall chapters and sections can be used individually in a course.

The organization is clear, user-friendly, and easily navigable using all-cap chapter headings and numbers and lower case section headings and numbers.

This text is offered in various formats which likely will help eliminate interface issues with certain sections. The section on resumes and cover letters, for example, might offer display differences depending on the format.

Grammatical errors were not detected.

Much of the text appeared to be neutral, and sections were dedicated to discussing cultural sensitivity within workplace writing. With that said, additional work on representation could be added within the examples. Also, ideas for inclusivity through accessibility in design of workplace documents might be added, too, as well as an updated discussion on gender in written communications beyond using Mr. or Ms. in the sections on email, cover letters, and audience.

This text is well organized with topics appropriate to technical writing, and I will consider using it in technical writing and workplace writing courses for first- and second-year students.

Reviewed by Erica Stone, English Instructor, Technical Writing, University of Missouri Kansas City on 6/19/18

The textbook is comprehensive; however, it seems to cover both technical writing and professional or workplace writing. It is absolutely appropriate for a comprehensive service course, but the authors should consider another title. Perhaps... read more

The textbook is comprehensive; however, it seems to cover both technical writing and professional or workplace writing. It is absolutely appropriate for a comprehensive service course, but the authors should consider another title. Perhaps Technical and Professional Writing would be more accurate.

There are a few minor typos and notes from a previous editor in the document and a few leftover editing notes. Regarding bias, the entire text does seem to be written for a particular course. While it is generalized, it does refer to particular assignments and contexts, sometimes without an example given.

The content is up to date; however, it may require revision as technologies evolve and change. For example, the texting section may need to be updated within the next year to account for newer texting apps and conventions.

The entire textbook is clear and accessible. In some places, it is conversational; however, I find that quality increases its accessibility and approachability, which is necessary for a technical writing service course.

The framework and organization of the textbook is consistent and easy to follow.

The modularity is helpful, and the text is well-organized.

All of the topics are presented in a logical and clear fashion.

All of the available interfaces work well.

I did not see any grammatical errors during my review. I did, however, see a few leftover notes from the editor.

The text is culturally appropriate and all example are relevant and inclusive.

In some places, the example links do not work. When there is time, the editors and/or authors should review the book to check for errors and broken links.

As mentioned in my first comment, the textbook could benefit from separating technical writing and professional writing as they are separate disciplines.

Reviewed by Michael Nern, Associate Professor, Emeritus, Ohio University Zanesville on 2/1/18

The book does not contain an index or a glossary. The book's primarily focuses on the proposal but also covers other traditional technical writing assignments such as the cover letter and resume. read more

Comprehensiveness rating: 3 see less

The book does not contain an index or a glossary.

The book's primarily focuses on the proposal but also covers other traditional technical writing assignments such as the cover letter and resume.

The content is accurate. I would not call the book error free.

The book contains relevant content that could be updated with relative ease.

The book's prose is not tightly edited, but the prose is accessible.

The book's content is consistent.

The text is well-organized for assigning smaller sections of reading at different points within a course.

The book's organization is solid and clear.

The text does not have interfacing issues.

The book needs a careful and close editing by one person.

I found the short chapter on ethics to be presented almost as an afterthought and believe it would be of little help to students.

I would use the book as a resource but not as a textbook for students. I might assign certain sections for reading but would more than likely use information from the book to add to already existing lectures and discussions, of course, giving credit to the authors.

In general, I believe both the Web and open source materials provide enough material to work with that textbooks in writing courses are unnecessary.

Reviewed by Jennifer Dareneau, Assistant Teaching Professor, The Pennsylvania State University- Berks on 2/1/18

Based on the Table of Contents, all subject areas mentioned there were covered adequately. However, there are several mentions of the technical report being the main document produced at the end of the term (which is true) and mentions of several... read more

Based on the Table of Contents, all subject areas mentioned there were covered adequately. However, there are several mentions of the technical report being the main document produced at the end of the term (which is true) and mentions of several prefatory documents needed for benchmarking along the way. Only a couple of those mentioned documents are detailed or explained in the book.

There are a few minor typos and notes from a previous editor in the document, including a question about permission to use a chart. Content itself seemed accurate.

Content is up to date. With the inclusion of sections on MLA and APA citation style as well as the job application chapters, it would need to be updated in about 5 years to reflect changes to those areas.

Clarity of language and expression of concepts is well done. Language is easy to understand but remains at a college student's level. Special terms are explained and defined.

For the most part, the book is internally consistent. There are some inconsistent elements- some chapters include links to samples, but not all; there is a link to one video only; some chapters include an activity prompt, but others do not.

Modularity is well done. Each larger unit is broken into smaller, easily understood and relevant sub units.

Organization is simple and logical.

I did not experience any navigation problems. Some images had an editor's note next to them, or were quickly covered by a small icon in the top right. The chapters on graphics had some photos that did not connect well to technical writing, and I suspect students in a class would struggle to understand the rhetorical significance of them (particularly the sections with Obama and the girls gymnastics team).

I noticed only one or two minor typos. There were some fragments and sentences beginning with And or But, which I hope were stylistic choices.

There were no culturally insensitive examples or remarks.

Reviewed by Ethan Jordan, Lecturer, Bowling Green State University on 2/1/18

The book covers a broad range of technical communication genres, and it covers everything I would hope to cover in my upcoming course. read more

The book covers a broad range of technical communication genres, and it covers everything I would hope to cover in my upcoming course.

Due to the objective nature of most technical writing, this book certainly follows suit and contains little in terms of bias or subjectivity. The document genres covered fit with standards in the field, and I have found very few errors.

I agree that this book will remain relevant over time. Certainly, notions of "netiquette" and online forms might change, but the essential tech comm genres covered will remain an essential component of workplace literacies, and as such, this book should remain relevant and be easy to update as needed.

The textbook is written in a voice that is straightforward and no-nonsense for students. It isn't the most scintillating reading, but a book on technical writing clearly doesn't need to be! The voice of the text is one that I feel students would appreciate - let's get to the point!

I don't see any major inconsistencies. The text works to reinforce technical communication concepts both in its subject matter and in the style of the text itself. Clarity and intelligibility are essentials, and the text appears to work within those frameworks.

I appreciate the way the sections aren't overly extended or complicated - the individual components make up the larger whole and could easily be reconfigured to suit the needs of instructors. I feel like this is less of a textbook to read in order, but a set of modules for instructors to customize.

The overall structure of the piece makes sense, and I found myself following the process outlined within the overall book structure. It also is able to be modified quite easily if needed, so that's a plus.

Some of the graphics are a bit low-res, but nothing that would inhibit meaning... it's well presented overall.

Very few that I can see!

I see no issues here - it's quite objective overall.

I'm really happy I found this one! It will be a huge help in my upcoming course, and I'm excited to use this as a supplement to my in-class discussions!

Reviewed by Elizabeth McClure, Lecturer, University of Maryland, College Park on 2/1/18

This text includes several sections that I would expect to see in a technical writing textbook: job search materials, reports, proposals, using graphics, professional communications, and audience analysis. It also includes a couple of sections I... read more

This text includes several sections that I would expect to see in a technical writing textbook: job search materials, reports, proposals, using graphics, professional communications, and audience analysis. It also includes a couple of sections I wouldn't necessarily expect, but that would be very useful in any professional writing class: discussions of the ethics involved in report writing, information literacy, and document design. However, there was no section related to manuals or instructions, which is a large gap.

In terms of usability in relation to comprehensiveness, the table of contents is nicely detailed, but no index appears so locating overlaps of information among and between chapters would not be as simple or straightforward as it could be.

In general, the information in the text is accurate, although some areas and issues would benefit from more nuanced or complex discussion. For example, in the section on job materials, professional advice varies widely related to the design of resumes, but this text does not discuss any of the variety of advice.

One minor note: There are several sentence-level errors (i.e., subject-verb agreement) that don't compromise communication but are occasionally jarring.

The content generally seems up-to-date, and the chapter organization and breakdown appear to lend themselves to easy updating.

Clarity rating: 3

The text’s language is clear and accessible. Sufficient background information is presented to give context for new concepts.

Other structures that would enhance clarity are not consistently present, however. For example, not all chapters provide examples to illustrate concepts or discussion/reflection questions to encourage students to apply concepts to other situations. Additionally, most chapters have no graphic material – pull-out text boxes, illustrations, summary lists, etc. – that would offer a different presentation method for readers.

This text is consistent in its approach, terminology, and framework.

This text is divided into sections in such a way that individual sections could easily be assigned out of order and at different points in a course. There are few, if any, instances in the text that refer to earlier material in a way that would make non-consecutive reading unworkable or unwieldy. In general, sections are relatively short and are organized under useful headings. Few subheadings are used within the text itself, although chapters are broken down into sections, each of which is labeled on the page and in the table of contents with a heading. These headings should make finding relevant sections in the text fairly easy.

The topics in this text progress clearly enough to avoid confusion, but less clearly than they could. For example, starting with Audience Analysis rather than with a variety of workplace communication genres (text, email, memos, etc.) would be more rhetorically sensible. The progression from Proposals to Information Literacy (research) to Citations to Progress Reports makes sense in that it follows the progression one might follow in a particular workplace project. However, while the order of chapters follows the process of writing a workplace document (proposal, research, progress report, technical report), it doesn’t necessarily follow the order of writing skills. For example, research is usually an integral part of developing a writing topic rather than something that happens at a single defined point mid-way through a project; likewise, a discussion of ethics should happen before a technical report is underway, perhaps in relation to an analysis of audience or to a discussion of the rhetorical situations present in professional writing generally. Because these chapters can be read out of order, the problem isn’t serious, but the chapter order doesn’t make as much use of logical development as it could.

In general, the text’s interface is user-friendly. There are a couple of places, however, notably in the chapter on design, where graphics don’t appear above the caption.

The text is overall clean but there are a handful of grammatical errors.

The text is inoffensive. Its examples aren’t culturally specific – examples don’t refer to particular groups at all, so diversity does not seem to be at issue.

Reviewed by Pam Orel, Senior Lecturer , University of Maryland College Park on 2/1/18

This is a very compact book, with easily managed lessons in basic concepts that are a quick and easy read for most students in the sciences and technology fields (STEM). Where it summarizes the key details, it does so with general clarity and the... read more

This is a very compact book, with easily managed lessons in basic concepts that are a quick and easy read for most students in the sciences and technology fields (STEM). Where it summarizes the key details, it does so with general clarity and the links to other, more detailed resources appear to be effective, although one or two are dated. It is not designed as a comprehensive or exhaustive resource on technical writing and avoids a heavily academic tone.

The book’s advice, while brief, is extremely solid, backed up by authoritative evidence, and easy to follow. Students would appreciate the very good detail in the table of contents as well as the ease of navigating from section to section as needed. Charts, where used, easily help students find the key differences in concepts, which is something that more detailed, less approachable textbooks tend to overlook.

In general I don’t teach with a textbook, so my comments should be taken in the context of someone who uses texts more as a resource than a work that guides the entirety of our semester’s journey as writers. This is a very relevant work for busy writers who need to grasp the essentials quickly, and get leads on how to find more detail as needed. It is particularly good at using graphics to shape ideas which is a factor in more and more writing courses. If I had to point to one area where it might need updating, it might be in allowing more space for instructions, presentations and video content, as these are emerging as valuable tools and I am not seeing a lot in the text. It appears to focus a lot on the preparation of reports and print materials, but is a good basic resource in those areas.

Very clear, with short, effective paragraphs and guides to other resources clearly labeled as such. As noted earlier, graphics are well supported in the version that I reviewed. It should be noted that different formats might have issues relating to page presentation, as I have noticed that in other primarily online references I have seen.

It can be inconsistent in terms of the amount of space given to, say, some issues over others. However, in general the issues which are not treated in great detail are those for which often there are other, key resources focusing on general principles involved that are attached. Also, in some instance (plagiarism is one example) there are a wealth of other resources available in most higher education communities.

The sections in the book are effectively broken into segments which are short but emphasize key points in about a page or so. This is one of the areas where it might be most attractive to students who rely on it as a reference rather than a week-to-week resource. Teachers who wish to use, say, one or two segments while not using others would find this a very helpful resource.

This is an area of strength for this publication, as it shapes very well around ideas for most proposal writers as well as the ethics of the field as we know it today. Ethical concepts are generally brief, but clear as to impact on the STEM fields. It would be stronger with a little more emphasis on presentations and video, as noted, which are important as digital communications tools for STEM majors.

The online interface I used was generally very easy; with both arrows and a table of contents, writers can easily move to where they need to get their information. It is noteworthy that it does not have questions in the back of each section, so it’s not designed for, say, test development or study for exams. But most technical writing courses don’t focus on exams (there may be quizzes on concepts) so that is not a significant barrier.

I was not able to find any significant errors in grammar.

This could be stronger in its approach to culture across the STEM communities, which is not a small issue in a global economy. However, one challenge with that is attempting to keep it current -- culture, like everything else in science and technology, changes very rapidly.

I have taught from a range of different resources, which change from year to year as it’s important to keep a course relevant in the rapidly evolving STEM fields. I have had trouble finding resources, particularly open source ones, that are approachable but convey the key concepts in an easy to access format. Students in my classes use a text as needed, rather than as the foundation of an entire course. This has worked very well in that role in this semester, and I am hoping to keep it on my list of resources moving forward.

Reviewed by Amanda Izenstark, Professor, Reference & Instructional Design Librarian, University of Rhode Island on 2/1/18

This text covers numerous facets related to technical writing, including basic business correspondence and determining how best to reach the audience for the particular type of technical writing being done. The authors cover related and integral... read more

This text covers numerous facets related to technical writing, including basic business correspondence and determining how best to reach the audience for the particular type of technical writing being done. The authors cover related and integral elements that help writers produce better documents, including using outlines and graphics as well as information literacy skills that writers should have. While there is no index or glossary, the table of contents clearly displays the content of the text. It’s worth noting that the table of contents on the Open Textbook Library website does not include the two final sections of the book, which cover “Design and Readability of Publications” and “Employment Materials.”

The book is accurate, and even in sections where elements might change - such as screenshots in the Information Literacy chapter - they are general enough that even if the interface changes, the instructions will be relatively similar.

The topics in the book are not likely to become dated immediately. Some of the basic material related to communication and being concise will be consistently useful. While some of the linked material may change over time, that isn’t the fault of the authors. When I reviewed this text, the links tested were still working and relevant.

The text is written at a level accessible for college-level students, and perhaps some high school students. The materials are logically arranged and easy to understand.

As some of the material includes elements remixed from other open texts, there are some differences in the language and layout of chapters. For example, some of the elements of chapter 12 related to cover letters and resumes use color, and have more modern examples than those in chapter 1, which focuses on online etiquette.

Many of the chapters will do well on their own. I plan to adopt this for my information literacy and writing course, and anticipate re-arranging sections to fit the course structure.

This may be a result of my background as a teacher of information literacy first, but it might make more sense to start with the sections on information literacy and citations, then progress to audience analysis and outlines. It seems the chapter on “Professional Communication” might fit better toward the end. Otherwise the flow and structure are generally logical.

The online version of the book is hosted on the Pressbooks platform, which is intuitive to use, but long sections require significant scrolling. The PDF version of the book works as expected, with functioning links in both the table of contents and the text.

There are no grammatical errors in the text, which is what one would expect from a writing textbook.

As appropriate, the book highlights cultural issues to consider when writing for an audience. Examples don’t highlight a variety of backgrounds, but neither are they so pervasive that it’s a problem.

Given the appropriately broad coverage of this text, I can envision it being useful to students after they leave my course and have jobs in their chosen fields.

Reviewed by Jim Crawford, Adjunct English Instructor, Germanna Community College on 2/1/18

I examined this textbook as a resource for a 100-level Technical Writing class. In this context, questions of comprehensiveness arose almost immediately. The authors offer no discussion of theory, despite a claim on page 1 that theory underlies... read more

I examined this textbook as a resource for a 100-level Technical Writing class. In this context, questions of comprehensiveness arose almost immediately. The authors offer no discussion of theory, despite a claim on page 1 that theory underlies technical writing. There was no mention of the writing process, a confusing oversight on two fronts. First, the omission raised questions about course level. Did the textbook assume students already understood writing as a process? That would put this text higher than entry-level; writing as a process is usually taught in 100-level English. Or, by omitting the writing process, does the textbook defy modern writing pedagogy and emphasize the products of technical writing over the process?

There was also no mention of the rhetorical situation: the amalgamation of purpose, stance and tone, genre, media, and, of course, audience. The text offers a separate chapter on analyzing the audience, but no holistic examination of the roles that purpose, stance and tone, genre, and media play in reaching the audience.

Omitting a discussion of the rhetorical situation elicits more questions about course level and students’ prerequisite knowledge. Does the text assume students understood the interaction of purpose, stance, and genre in a writing project? The textbook mentions purpose, almost in passing - the purpose of a memo, for instance, or a report. Stance - how the writer feels about the topic versus how she expresses it through her tone - was not addressed at all. Given that technical communicators may be asked to write about things they don’t care about or may disagree with (e.g., an environmentalist writing a press release on new oil exploration), a discussion of stance and tone is important.

Lacking an essential discussion of theory and concept, the textbook covers a limited range of genres, another writerly term that is not mentioned. The first chapter reviews types of correspondence, starting with, oddly enough, texting. Next, comes e-mail, then an interjection about netiquette, followed by brief discussions of memoranda and letters. Later chapters describe proposals and progress reports. A recent revision added a chapter on employment-related documents, such as résumés.

While this is an adequate list of technical genres, the choices seemed limited and specific. Why the focus on progress reports? A broader chapter covering incident or recommendation reports seems more thorough. Other key genres are missing entirely. Instructions get no mention, although giving directions and documenting procedures are common workplace tasks. Presentations are another key genre for technical communication that is overlooked in the textbook.

Among the genres that are discussed, accuracy falters due to a handful of random, undocumented prescriptions. On page 12, for example, the authors declare,” a good e-mail should get to the point and conclude in three small paragraphs or less.” Really? According to who? In my 30 years of experience in the technical workforce, I have read, and written, countless e-mails longer than three short paragraphs. While I agree that students should keep e-mails short and direct, especially when corresponding with the instructor, there is nothing inherently wrong about a longer e-mail message. Some arguments cannot be made in three short paragraphs. Are the authors saying that longer arguments are better suited for a memorandum or a letter? If so, that indicates a need to discuss the conventions of genre. If the authors are recommending the abbreviated length as a best practice for emerging technical communicators, they should say so. If the authors proclaim the three-paragraph limit as their personal preference, they should say that, too. However, they must also inform students that they may occasionally need to write, and read, longer e-mails in the workaday world.

A similar prescription occurs on page 36, with the decree that “an average between 15 and 25 words per sentence is about right. Sentences over 30 words are to be mistrusted.” Again, I wondered, “Says who?” Had the authors cited evidence — a study finding that sentences over 25 words are ignored by readers, for instance — the claim might be more compelling. Lacking documentation, it’s puzzling at how five additional words can separate an effective sentence from an untrustworthy one.

Furthermore, while conciseness is an essential feature of technical and professional writing, establishing an arbitrary sentence length may encourage students to emphasize conciseness at the expense of clarity and accuracy. It would be more effective to educate students on the relationship between clarity, conciseness, and accuracy, and teach them to use the shortest, clearest, most direct language needed to effectively address the audience and accomplish the purpose of the text. But this relationship is impossible to discuss with this text, since overarching concepts and conventions are never introduced.

The digital nature of the textbook assures easy editing and the potential for long-term relevance. In fact, between July 2017, when I downloaded a PDF copy for review, and October 2017, when I began writing the review, the authors added chapter 11 on design and readability, and chapter 12 on writing employment materials. They also expanded chapter 10, adding information about successful report design.

As with comprehensiveness and accuracy, clarity is marred by odd omissions. Page 12 advises that “professional communications require attention to the specific writing context” but there is no explanation of what context is. Again, a question about prerequisite knowledge arises. Can the authors assume that students understand what context is, and how it impacts a writing product?

Another missed opportunity occurs on page 16, where the authors admonish “culture and even gender can play a part in how people communicate.” While this is undoubtedly true, two questions arise. First, can instructors assume that students will recognize this intricate interaction? Second, can instructors assume that students will tailor their writing to navigate the interaction and improve communication? Lacking examples, explanations, or a declaration of prerequisite knowledge, the answer to both questions is “no.”

Clarity is further diminished by Inconsistencies within the text. Chapter 8, “Creating and Integrating Graphics,” recommends “including identifying detail in the graphics” (128), yet does ignores its own advice. The sample bar chart on page 123, depicting types of produce grown in Sisters, Oregon, has axis titles, but the y-axis, entitled “Percentage produced in 2015,” has no scale. The chart shows that potatoes are the most plentiful crop. Its bar towers over that of carrots, the closest competitor, by about two-thirds. But, without a scale, the value for potatoes could be 30 percent, or 3 percent, compared to carrots at 10 percent or 1 percent.

A pie chart on page 122 shows a similar dearth of detail. The chart is entitled, simply, “Success with Vegetables Grown.” Potatoes account for 60 percent of vegetables grown; carrots for 23 percent. But percent of what? The pie chart doesn’t say. Is it percent of all total crops grown? Is it percent of crop yield, compared to crops planted? Students are left guessing, and, from this, may learn to create charts that inspire their own guesswork. More subtle inconsistency arises in the textbook’s formatting. Chapter 1, on correspondence, uses at least three different formats for bullet points. Pages 12-13 list characteristics of e-mail with bullets featuring a bolded opening phrase. Pages 15-16, on netiquette, uses headings, along with simply, un-bolded bullet points. Meanwhile, page 24 presents a list of correspondence types with no bullets at all; the different types are simply bolded. These inconsistencies model poor document design for students. This is especially problematic given the text’s emphasis on longer documents, such as the progress reports, which require consistent formatting throughout.

Formatting inconsistencies notwithstanding, the text is well-marked for modularity. Clear, consistent headings and sub-headings are used throughout. Students should have no trouble identifying a reading assignment such as “chapter 9, sections 9.1 through 9.3.”

Alas, the headings and sub-headings demarcate a haphazard arrangement of content. Topics are not grouped according to theory (should there be any) and practice, strategies and genres, or from easiest material to more challenging. The chapters appear randomly, with an early chapter often referring to material that has not been introduced yet. Chapter 1, on correspondence, advises, “careful consideration should be given to the audience...” (9), but the chapter on audience analysis follows 14 pages later.

Considering the recent addition of chapters on design and employment documents, it appears that chapters are organized in the order that they’re added. New chapters are simply tacked on at the end. While such labor-saving is understandable, it may be worth the effort to reorganize the textbook by introducing overarching concepts, such as audience, research methods, and ethics at the beginning, with specific writing strategies (e.g. outlining) and genres to follow.

This review was prepared from a print-out of a PDF file generated on the textbook’s Web site. Although the charts and graphics conveyed when printed, the videos, understandably, did not. It would have been helpful to include URLs for the videos, so that students preferring a paper-based text could find and watch the videos while reading.

The interface for the Web version of the book is clear, simple, and unobtrusive. [Home] and [Table of Contents] buttons are fixed on the right-hand side, allowing students to easily jump among sections. Gray “forward” and “backward” arrows, on the right and left, respectively, make it easy to flip pages. A “search” box, almost invisible in the upper, right-hand corner, offers quick full-text searching. A search for “audience” returned a list, itemized by clickable links to specific sections containing the term. Traditional search conventions, such as double-quotes to find phrases, work as expected. However, more sophisticated search operators, such as “AND,” “OR,” “NOT,” and “NEAR” do not work, though this is not a major shortcoming.

There were no noticeable grammatical errors, though there were occasional long, wordy, confusing sentences. The sentence describing crop yields in Sisters, Oregon was a staggering four lines long, strung together with “and” between three independent clauses (121).

Generally, the text is inoffensive. There was, however, one off-putting cliché: the notion that older people are slow to grasp technical concepts. The book’s Introduction advises, “…plan to write in such a way that even Grandad can understand!” (3). While this was surely a throwaway attempt at levity, the cliché may be discouraging to older students, while cultivating the bias of younger ones.

Reviewed by Linda Stewart, Instructor, Portland Community College on 6/20/17

The text covers proposals and progress reports in depth with links to examples of other types of technical writing including resumes and instructions (but no discussion of these forms in depth). The text does not cover multi-cultural audience in... read more

The text covers proposals and progress reports in depth with links to examples of other types of technical writing including resumes and instructions (but no discussion of these forms in depth). The text does not cover multi-cultural audience in any depth and does not consider disabled audiences (including visually impaired audiences). The text does not include an index or glossary.

The book is accurate, error-free, and unbiased.

The text begins with the most common kinds of professional communication, including texts and e-mails, which demonstrates an understanding of current workplace needs. This section may need updating since technology brings changes to workplace communications. The section on research rightly emphasizes electronic sources, and this too, may need updating as library databases and other electronic sources may change. Other sections, like the ones on audience and ethics, will not need updating.

Students would enjoy the bulleted lists and simple, readable prose. The authors provide some excellent, labeled figures and graphics so that students can comprehend the main ideas quickly. The authors do a good job of defining terms, but students will need to read the text to discover the important terms; no sidebars or lists are used to call attention to specialized vocabulary.

The formatting and tone are consistent with good use of numbered sub-topics and bulleted lists in each chapter. The sources provided as links are not consistent with the formatting of the main text. For instance, the link to examples (titled "Online Technical Writing: Contents") uses yellow background and blue lettering, and does not include any explanatory text. This linked resource is not formatted as professionally as the main text. The terminology is internally consistent.

The text is well organized and clearly divided into smaller reading sections that can be assigned at different points within the course.

Problems with organization: Since the topic of "ethics" is one that applies to all forms of technical writing, it seems out of place as "Chapter 9." It also seems that "Outlines" might be addressed sooner since those could apply to writing proposals as well as progress reports. Finally, it seems odd to separate the chapters on graphics and document design (they are chapters 8 and 10 with the ethics chapter in between them.

The overall organization progresses logically from shorter forms of technical writing to longer, more complex ones.

The text is free of significant interface issues, including navigation problems or problems with display.

The authors observe standard conventions of grammar.

The text is not culturally insensitive or offensive. The authors could do more to include a variety of races, ethnicities, and backgrounds as part of their discussion of "audience"

The text does an especially good job of explaining how to write proposals and reports in a clear, step-by-step manner.

Reviewed by Carol Jacobson, Instructor, Century College on 6/20/17

The text covers all areas that are part of the technical writing curriculum. There is a detailed Table of Contents that lays out the subjects that are covered. There is no index or glossary. read more

The text covers all areas that are part of the technical writing curriculum. There is a detailed Table of Contents that lays out the subjects that are covered. There is no index or glossary.

Content is accurate and error-free.

Content is current for the technical market. It covers current topics and concerns, but also includes all the traditional topics expected for Technical Writing courses.

The text gives full explanation of the content.

The text was consistent with its terms.

The text is divided into multiple sections that are each on a different topic or focus so these sections could be easily assigned at different point for a course.

The topics of the text are ordered in a logical way, beginning with topics that should be covered first in a Technical Writing course.

Some of the images are blurry and hard to see. The 2 videos are designed by an instructor for a specific course and reference specific assignments for that course so these are not good choices for this textbook that is meant to be a general source for any Technical Writing course.

The text contains no grammatical errors.

The text is presented in a neutral way with no offensive or insensitive words or examples.

The format of the content is very text heavy in paragraph structure, which is odd for a Technical Writing book because a general rule in Technical Writing is to use shorter, concise paragraphs with more lists, bullets, and tables for easy reading and referencing of the information. In addition, the text needs more real-life example that demonstrate the points being made in each section.

Reviewed by Shannon Kelley, English Faculty, Chemeketa Community College on 6/20/17

The text covers a good amount of information related to technical writing; some of the sections are more in depth than others. Many sections would benefit from further inquiry to assist students with more complex issues in the field of technical... read more

The text covers a good amount of information related to technical writing; some of the sections are more in depth than others. Many sections would benefit from further inquiry to assist students with more complex issues in the field of technical writing and communications. While all of the topics are relevant, it sticks to the basics of each topic without exploring innovations and trends in the field. The topics covered are appropriate for a low-level, introductory course in technical writing.

The book is accurate and unbiased. It is a straight-forward text that introduces the basics of technical writing in a clear, error-free format. Each chapter provides references and is accurately cited. The examples are neutral and helpful.

Relevance/Longevity rating: 3

The content is relevant, but not exhaustive. The text does not cover new trends in the field. Many technical writing students, particularly in community college courses, are entering a variety of fields. While this text provides the basics of technical writing, it does not help with a variety of concerns students may face in their chosen fields.

The text is arranged in way that will allow for necessary updates moving forward. The text seamlessly incorporates modalities, like video links, that prove helpful as examples. More of these new modalities are desirable as writing and reading moves to the Internet. There are places in the text that could benefit from utilizing new, innovative examples.

The text is written clearly and concisely. Each chapter is divided into sections. The section and chapter headings create parallelism that helps its overall clarity. The table of contents is clear and easy to use. There is not a lot of technical jargon present; the lack of technical writing terminology is one reason the book reads like introductory material.

The text is consistent in its layout. It is easy to use and access. The structural framework of the text is effective for online reading.

The text is not self-referential, but it does reference information only relevant to COCC. The text is divided in a way that feels manageable for students. The downside is the text borders on being too modular. The sections felt purposefully shortened and many chapters left me wanting more information. For instance, visual rhetoric and page layout were lumped together with audience. And in terms of this topic, topics like those deserve their own exploration.

The text works itself through the basics, from small workplace writing tasks like emails and memos, up through more complex writing like proposals and reports. Thought was given to the order of the text and it is logical and predictable.

There were no interface issues as I reviewed the text. i downloaded it as a PDF and also read some parts online.

The text contains no grammatical errors. It was edited well. The grammar is basic and reads at an introductory level reading.

The text remains neutral and uses voice or cartoon like figures in some of the videos. I would have liked to see more examples throughout the text. Visuals and page layout are important features of a lot of technical writing and this text doesn't take advantage of opportunities to incorporate a variety of examples. There are opportunities throughout the book that allow for incorporation of examples from fields of nursing, human services, engineering, computer science, and education.

It should be noted that I am reviewing this text for a 200 level course. At Chemeketa Community College students enter technical writing after completing two-three levels of prerequisite writing courses. Technical writing is the highest level of writing students receive before they enter their professional fields or transfer to four-year universities. The book is well written, clear, useful, and comprehensive for an introductory course, but not for a higher level technical writing course. Much of the focus felt repetitive and covered skills students in technical writing should already possess. There were missed opportunities to expand some of the more relevant topics, like the importance of visual rhetoric in page layout; solicited and unsolicited proposals; and, analytical report writing like feasibility studies.

Reviewed by Daniel Hocutt, Web Manager & Adjunct Professor, University of Richmond School of Professional & Continuing Studies on 4/11/17

The text does not include an index or glossary, but does provide a comprehensive table of contents. The text introduces itself as an introductory text to technical writing (or communication), and provides a definition of technical communication... read more

The text does not include an index or glossary, but does provide a comprehensive table of contents. The text introduces itself as an introductory text to technical writing (or communication), and provides a definition of technical communication that is limited to the types, content, and coverage of texts created. A more comprehensive text would address some of the responsibilities of technical writing as it relates to the technical writer herself: team building and collaboration, intermediary across multiple departments and divisions; and negotiator of meaning in workplace cultures. Also missing from the text are generous examples of document types generated by technical writers, like websites, brochures and flyers, and other types of written communication. The text's focus on report writing seems limiting, and its approach to technical writer as largely autonomous does not accurately reflect the complexity of technical writing workplaces.

The content is up-to-date and appears to be thoroughly accurate. Its authors clearly understand and practice technical communication, and its integration of external tools and links are current, complete, and appropriate to the content of the text itself. Chapters in the text address real-world examples and seek to connect communication techniques to workplace and technical contexts. Of particular importance is the text's approach to communication as audience focused and customized; this reflects theoretical accuracy and currency in technical and professional writing and, more broadly, in rhetoric and communications.

The applicability of this question to a text on technical communication is somewhat misplaced; technical writing handbooks must follow technical advances that will necessarily render older technologies less relevant. For example, the section on texting would not have appeared in earlier editions of this text, while the section on memoranda feels somewhat dated in paper-less or paper-reduced workplaces. As a result, the content will regularly have to be updated as modes and media of communication and writing evolve. This is a problem of all technical writing texts, but it's particularly acute as it relates to an online text, which will likely be expected to be current, relevant, and inclusive of the latest trends in technology and writing.

The text is remarkably approachable to its intended audience, those entering into the field of technical writing or those who will, by virtue of their technical positions, be required to compose technical artifacts. Its prose is clear and specific, and it follows the guidelines for writing technical prose that it presents to reader: clear, concise, and effective.

The field of technical and professional communication tends to use terms somewhat synonymously, so the conflation of certain terms in the text is not unusual in the field. For example, “writing” and “communication” are often used largely synonymously in the field, and that practice is also followed throughout this text. The same is true of “business” and “professional” as it relates to writing and communication. An introductory text should seek to better follow consistency while explaining the issues that exist in the field.

The text is quite modular, to the point that certain parts of it might be combined to keep from creating extremely short chapters or sections. This is especially true of several introductory sections. In general, segments are only a few paragraphs in length, with modules easily excerpted for re-use or revised usage. I could definitely see the potential of a teacher taking certain sections and incorporating them into class notes or as a customized resource. But I also see the value of using the entirety of the text as a stand-alone text; I believe the text’s structure enables both uses with little revision or customization necessary.

The text’s organization is not as clear or logical as I would expect. Given that modules or sections can be reordered on demand, this is not a significant drawback. However, I found the default order of modules confusing, shifting between more general, theoretical approaches (like audience analysis and information literacy) and more specific practical approaches (like proposals and progress reports) without a clear rationale for shifting from one to the other. A more logical structure might be to address the general theory in an opening section that includes examples for illustration, then to include a second section to address specific genres and types of technical writing. The structure is not off-putting, but as someone who might consider teaching from this text, I question the rationale behind the logic but am given little explanation.

The text’s interface is clean and clear. Serif fonts are a little unusual in web documents, but the type style used is quite readable online. Table formats don’t always fit on the page, and this requires left/right scrolling to access some of the columns. The text includes few images; most are linked to accessible PDF versions, which are full-screen and easy to read. Embedded videos appear to function as expected; the interface could benefit from a column-width inline viewer that would keep the video window from being narrower than the text columns. This is likely a result of making the interface mobile responsive, and represents what is often a necessary compromise.

Like its prose, the grammar appears to be clean and normalized to American standard English. The tone can be academic, but that is to be expected from a text used in an introductory classroom. I found no grammatical errors.

I did not encounter ethnicity- or gender-specific language in the text. The examples provided represent a number of different document types and genres, generally focused on the professional workplace or the academic environment. However, no text will free itself completely from ideology; I might like to have seen the text more directly address this issue as it relates to business writing. The text could do more to explore cultural contexts in which technical documents are planned, prepared, and consumed, especially given increasing internationalization of workforces. This may reflect an issue with the field — we tend to classify international communication differently from general technical communication — but a section on writing in the global community and for cross-cultural audiences might be useful.

I did not expect to find an open textbook as useful or well-constructed as this is. While its cover and design are unassuming — which, for a text on technical writing, might be a drawback — its content is erudite and targeted to its primary audience and purpose. I would consider using this text in an introductory technical writing class, with the addition of several notable sections identified elsewhere in this review.

Reviewed by Ruth Perkins, Adjunct instructor, Chemeketa Community College on 4/11/17

The text clearly focuses on research and report writing in a business context. These are appropriately and adequately covered. The table of contents is detailed and accessible on each page with a link to each section. The chapters lead students... read more

The text clearly focuses on research and report writing in a business context. These are appropriately and adequately covered. The table of contents is detailed and accessible on each page with a link to each section. The chapters lead students through the steps of producing a formal report including research, proposals, citation, and progress reports. There is a useful section on information literacy and conducting research beyond the first items in a Google search.

The importance of keeping readers in mind is stressed throughout. In addition to a link to an audience worksheet, there is a clear explanation of how reports might be used by different readers.

Chapter 10 includes a link to a wide variety of examples of technical writing.

Missing are sections on topics often included in technical writing: instructions, procedures, descriptions and definitions. These could be easily fit into the overall structure of the text although obviously other sources of information would need to be found.

The principles of professional communication are accurately presented. The authors make the useful point in several places that a business, agency, journal etc. will likely have its own preferences for professional communications but that some aspects, such as avoiding plagiarism, doing proper research, are consistent.

The content is up-to-date since there are not apt to be quick changes to the principles of technical writing nor to the precepts of e-mail, texting etc. and their place in business. Any changes could be quickly made.

There are links that are specific to or have comments that are specific to COCC that instructors will probably want to point out and substitute their institution’s or their class policy. Examples are the links in 1.3 and 6.2.

The book is clearly written in an informal, conversational tone that should appeal to students. The terminology is basic without down-writing. Any specialized terms are defined.

The link in 8.4 to visuals that need revision is probably not useful for most classes. Figures 1 and 2 are very specialized.

The text is consistently organized. There are clear signals that link each section to the main section. The emphasis is on professional communication throughout so chapters are linked through that context.

In section 4.1 there is inconsistency in terminology where “academic” and “scholarly” are used interchangeably.

The book is clearly arranged into chapters with clear titles and headings. The table of contents is linked to each section for quick finding. The pages have ample white space and large readable type.

The book is clearly organized around the perspective of researching and writing a final report. The chapters can easily be rearranged according to an instructor’s preference since the table of contents is linked to each section.

However, the book is arranged in a logical progression through the different aspects of research and writing the formal report.

The book is posted in 4 different formats which makes it readily accessible to students. There is an important missing link in 9.2. This link in 4.3 is no longer valid: The Research Cycle derived from A Cycle of Revolving Research by UC Libraries, CC: BY-NC-SA 3.0 Otherwise there are no issues.

There are grammatical errors in section 9 as well as confusing switches in point of view.

Grammar errors: 9 “Writers . . . she” 9.3 “. . .your employer to pursue and action” and “the groups’ goal”

Point of view First, chapters 1-8 and 10 are written in second person. Chapter 9 is written partly in second person, partly in third person. While some references to “the writer” are logical, it inconsistently directly addresses readers or talks about writers in general.

Second, there is inconsistency in an attempt to be gender neutral in the third person. In 9 “she” and “he” are used interchangeably. 9.3 uses “her/himself,” “s/he,” and “his/her.”

The examples in the text and references to writers are neutral. There is nothing to identify a particular culture, race or ethnicity.

The book doesn't completely fit the course in technical writing that I teach but I would consider using if it did. However, I do have some problems with Chapter 9, ethics in technical writing, that I would like to see addressed. These are in addition to the grammatical issues.

In 9.1 General Principles, the authors give examples of ethical dilemmas that range from trivial to life and death. These do more to complicate the subject than clarify it. Part of this is due to the phrasing about the friend’s haircut, “This lie, though minor, preserves . . .” What is “though” doing in this sentence? It signals a contrast which isn’t there.

More of a concern though is the phrasing of the third choice of saving lives. The person might “risk [her life] to save her children” but to save the stranger, she would have to “choose to die.” Risk and certainty are not equal choices.

The second paragraph concludes that “If you would . . . lose your job. . . the action is probably unethical” oversimplifies -- one can lose a job for being ethical as well.

Section 9.2 includes the Challenger disaster as an example of unethical writing. The missing link is vital here since there are definitely different accounts of the underlying causes beyond the O rings. The authors speculate about possible motives of the engineers with no source information to support their conjectures. They make statements about the priority of information in the engineers' report which imply that they are in a position to make that judgment.

I suggest deleting or re-writing this section of the book.

Reviewed by Corrine Holke-Farnam, Instructor, University of Northern Iowa on 2/8/17

The text provides an adequate overview of the field for beginners in technical writing. read more

The text provides an adequate overview of the field for beginners in technical writing.

The content is accurate and straight forward.

The text is up-to-date and covers the range of topics addressed in introductory technical and professional writing courses.

The information is presented effectively in clear, concise language. Provides accurate definitions and many links to examples for easy understanding.

I found no internal inconsistencies.

Text is user-friendly. Effective use of white space. Employ small chunks of text, bullet point lists, and hyperlinks.

Many technical writing textbooks begin with audience analysis. Hamlin, Rubio, and DeSiva begin with common types of professional communication like email and memo format; doing so provides an effective context for beginning writers. The chapters of the book could be easily reorganized to fit user needs and/or preferences.

The text is free of interface issues. Navigation between and within chapters is smooth. Website links opened easily.

Technical Writing contains no grammatical errors.

The text revolves around professional communication. Does not contain offensive or insensitive material or links.

This text seems like a good fit for students in my Technical Writing for Electrical Engineering Technologists course. Practical information, concise presentation.

Reviewed by Jennifer Barton, Advanced Instructor, Virginia Tech on 2/8/17

The book appears to be written for a course designed around a specific major project that asks students to write a proposal for a technical report and then to research and write the report itself. Those sections are adequate, but I would like to... read more

The book appears to be written for a course designed around a specific major project that asks students to write a proposal for a technical report and then to research and write the report itself. Those sections are adequate, but I would like to see more content in general.

In particular, I would like information on writing instructions and technical descriptions, as well as the finer points of correspondence writing, like strategies for persuasion, or handling negative news, or emphasizing reader benefits. I would also like to see information on team writing—a must for the modern workplace. The book would also benefit from a section on presentations and a broader section on document design. The current section on design is specific only to reports and is really about organization, not design.

The content is accurate. The book sticks to the basic writing principles which don’t change much over time. I especially appreciate the repeated emphasis on audience and that while particular elements are expected for particular genres, organization and approach can and should be modified to suit the writer’s purpose and the needs of the audience.

The core principles aren’t likely to go out of date any time soon. The limited scope and lack of discussion about the design expectations of the modern audience does make the book feel dated.

Although the concept of linking to examples and additional information is an excellent use of this medium, the choice of links could be improved. For example, many of the linked reports are nearly twenty years old, and while they may demonstrate many of the writing principles that stay constant over time, they do not demonstrate contemporary expectations for design, and the topics are so dated as to make them seem irrelevant to most students.

The authors do an excellent job of adhering to plain language principles. The style is clear, simple, and direct. It reads like the authors are speaking directly to the audience.

As mentioned previously, the book reads as though it were designed for a very specific class. It shifts quite a bit between universal advice about writing for a professional audience and specific advice about writing for an instructor. That’s confusing and limits the book’s applicability.

The book is divided into logical sections that would make it easy to customize for a course if not for the problem previously cited of its being designed around a specific course’s project.

Follows a familiar and standard organization for workplace writing textbooks, beginning with basic correspondence and working towards longer and more complex reports.

Some easily correctable issues here: Many widowed headings (which the text advises to avoid). Figures and tables are not always labeled correctly.

The visual weight of “Chapter Attribution Information,” which is currently the same as chapter titles, should be reduced. In some chapters, that information is repeated before every section, which adds visual clutter.

There are additional problems in the pdf version that make it the pdf only partially usable: Text boxes tend to exceed the width of the page and cannot therefore be read. Everything is rendered as plain text, which means that table formatting is screwy and all images (including images of example documents) are missing. Citations get embedded directly into the text.

Grammar looks fine.

Deals very little with cultural issues, which is surprising given the global ventures of many companies and the increasingly diverse workforce in the US.

The book has the potential to be quite good, but I don't think it’s yet ready to compete with the for-profit options. I look forward to seeing subsequent editions.

Table of Contents

  • 1. Professional Communications
  • 2. Audience Analysis
  • 3. Proposals
  • 4. Information Literacy
  • 5. Citations and Plagiarism
  • 6. Progress Reports
  • 7. Outlines
  • 8. Creating and Integrating Graphics
  • 9. Ethics in Technical Writing
  • 10. Technical Reports: Components and Design
  • 11. Basic Design and Readability in Publications
  • 12. Employment Materials
  • 13. Communicating across Cultures
  • 14. Thinking about Writing

Ancillary Material

About the book.

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 integrating graphics. Written especially for an academic setting, this book provides readers with guidance on information literacy and documenting sources. This book was collected, adapted, and edited from multiple openly licensed sources.

About the Contributors

Annemarie Hamlin is an Associate Professor of English at Central Oregon Community College.

Chris Rubio is an Assistant Professor at Central Oregon Community College in Bend, OR.

Contribute to this Page

Have a language expert improve your writing

Run a free plagiarism check in 10 minutes, generate accurate citations for free.

  • Knowledge Base
  • Research paper

How to Write a Research Paper | A Beginner's Guide

A research paper is a piece of academic writing that provides analysis, interpretation, and argument based on in-depth independent research.

Research papers are similar to academic essays , but they are usually longer and more detailed assignments, designed to assess not only your writing skills but also your skills in scholarly research. Writing a research paper requires you to demonstrate a strong knowledge of your topic, engage with a variety of sources, and make an original contribution to the debate.

This step-by-step guide takes you through the entire writing process, from understanding your assignment to proofreading your final draft.

Instantly correct all language mistakes in your text

Upload your document to correct all your mistakes in minutes

upload-your-document-ai-proofreader

Table of contents

Understand the assignment, choose a research paper topic, conduct preliminary research, develop a thesis statement, create a research paper outline, write a first draft of the research paper, write the introduction, write a compelling body of text, write the conclusion, the second draft, the revision process, research paper checklist, free lecture slides.

Completing a research paper successfully means accomplishing the specific tasks set out for you. Before you start, make sure you thoroughly understanding the assignment task sheet:

  • Read it carefully, looking for anything confusing you might need to clarify with your professor.
  • Identify the assignment goal, deadline, length specifications, formatting, and submission method.
  • Make a bulleted list of the key points, then go back and cross completed items off as you’re writing.

Carefully consider your timeframe and word limit: be realistic, and plan enough time to research, write, and edit.

Receive feedback on language, structure, and formatting

Professional editors proofread and edit your paper by focusing on:

  • Academic style
  • Vague sentences
  • Style consistency

See an example

technical writing academic paper

There are many ways to generate an idea for a research paper, from brainstorming with pen and paper to talking it through with a fellow student or professor.

You can try free writing, which involves taking a broad topic and writing continuously for two or three minutes to identify absolutely anything relevant that could be interesting.

You can also gain inspiration from other research. The discussion or recommendations sections of research papers often include ideas for other specific topics that require further examination.

Once you have a broad subject area, narrow it down to choose a topic that interests you, m eets the criteria of your assignment, and i s possible to research. Aim for ideas that are both original and specific:

  • A paper following the chronology of World War II would not be original or specific enough.
  • A paper on the experience of Danish citizens living close to the German border during World War II would be specific and could be original enough.

Note any discussions that seem important to the topic, and try to find an issue that you can focus your paper around. Use a variety of sources , including journals, books, and reliable websites, to ensure you do not miss anything glaring.

Do not only verify the ideas you have in mind, but look for sources that contradict your point of view.

  • Is there anything people seem to overlook in the sources you research?
  • Are there any heated debates you can address?
  • Do you have a unique take on your topic?
  • Have there been some recent developments that build on the extant research?

In this stage, you might find it helpful to formulate some research questions to help guide you. To write research questions, try to finish the following sentence: “I want to know how/what/why…”

A thesis statement is a statement of your central argument — it establishes the purpose and position of your paper. If you started with a research question, the thesis statement should answer it. It should also show what evidence and reasoning you’ll use to support that answer.

The thesis statement should be concise, contentious, and coherent. That means it should briefly summarize your argument in a sentence or two, make a claim that requires further evidence or analysis, and make a coherent point that relates to every part of the paper.

You will probably revise and refine the thesis statement as you do more research, but it can serve as a guide throughout the writing process. Every paragraph should aim to support and develop this central claim.

A research paper outline is essentially a list of the key topics, arguments, and evidence you want to include, divided into sections with headings so that you know roughly what the paper will look like before you start writing.

A structure outline can help make the writing process much more efficient, so it’s worth dedicating some time to create one.

Your first draft won’t be perfect — you can polish later on. Your priorities at this stage are as follows:

  • Maintaining forward momentum — write now, perfect later.
  • Paying attention to clear organization and logical ordering of paragraphs and sentences, which will help when you come to the second draft.
  • Expressing your ideas as clearly as possible, so you know what you were trying to say when you come back to the text.

You do not need to start by writing the introduction. Begin where it feels most natural for you — some prefer to finish the most difficult sections first, while others choose to start with the easiest part. If you created an outline, use it as a map while you work.

Do not delete large sections of text. If you begin to dislike something you have written or find it doesn’t quite fit, move it to a different document, but don’t lose it completely — you never know if it might come in useful later.

Paragraph structure

Paragraphs are the basic building blocks of research papers. Each one should focus on a single claim or idea that helps to establish the overall argument or purpose of the paper.

Example paragraph

George Orwell’s 1946 essay “Politics and the English Language” has had an enduring impact on thought about the relationship between politics and language. This impact is particularly obvious in light of the various critical review articles that have recently referenced the essay. For example, consider Mark Falcoff’s 2009 article in The National Review Online, “The Perversion of Language; or, Orwell Revisited,” in which he analyzes several common words (“activist,” “civil-rights leader,” “diversity,” and more). Falcoff’s close analysis of the ambiguity built into political language intentionally mirrors Orwell’s own point-by-point analysis of the political language of his day. Even 63 years after its publication, Orwell’s essay is emulated by contemporary thinkers.

Citing sources

It’s also important to keep track of citations at this stage to avoid accidental plagiarism . Each time you use a source, make sure to take note of where the information came from.

You can use our free citation generators to automatically create citations and save your reference list as you go.

APA Citation Generator MLA Citation Generator

The research paper introduction should address three questions: What, why, and how? After finishing the introduction, the reader should know what the paper is about, why it is worth reading, and how you’ll build your arguments.

What? Be specific about the topic of the paper, introduce the background, and define key terms or concepts.

Why? This is the most important, but also the most difficult, part of the introduction. Try to provide brief answers to the following questions: What new material or insight are you offering? What important issues does your essay help define or answer?

How? To let the reader know what to expect from the rest of the paper, the introduction should include a “map” of what will be discussed, briefly presenting the key elements of the paper in chronological order.

The major struggle faced by most writers is how to organize the information presented in the paper, which is one reason an outline is so useful. However, remember that the outline is only a guide and, when writing, you can be flexible with the order in which the information and arguments are presented.

One way to stay on track is to use your thesis statement and topic sentences . Check:

  • topic sentences against the thesis statement;
  • topic sentences against each other, for similarities and logical ordering;
  • and each sentence against the topic sentence of that paragraph.

Be aware of paragraphs that seem to cover the same things. If two paragraphs discuss something similar, they must approach that topic in different ways. Aim to create smooth transitions between sentences, paragraphs, and sections.

The research paper conclusion is designed to help your reader out of the paper’s argument, giving them a sense of finality.

Trace the course of the paper, emphasizing how it all comes together to prove your thesis statement. Give the paper a sense of finality by making sure the reader understands how you’ve settled the issues raised in the introduction.

You might also discuss the more general consequences of the argument, outline what the paper offers to future students of the topic, and suggest any questions the paper’s argument raises but cannot or does not try to answer.

You should not :

  • Offer new arguments or essential information
  • Take up any more space than necessary
  • Begin with stock phrases that signal you are ending the paper (e.g. “In conclusion”)

There are four main considerations when it comes to the second draft.

  • Check how your vision of the paper lines up with the first draft and, more importantly, that your paper still answers the assignment.
  • Identify any assumptions that might require (more substantial) justification, keeping your reader’s perspective foremost in mind. Remove these points if you cannot substantiate them further.
  • Be open to rearranging your ideas. Check whether any sections feel out of place and whether your ideas could be better organized.
  • If you find that old ideas do not fit as well as you anticipated, you should cut them out or condense them. You might also find that new and well-suited ideas occurred to you during the writing of the first draft — now is the time to make them part of the paper.

The goal during the revision and proofreading process is to ensure you have completed all the necessary tasks and that the paper is as well-articulated as possible. You can speed up the proofreading process by using the AI proofreader .

Global concerns

  • Confirm that your paper completes every task specified in your assignment sheet.
  • Check for logical organization and flow of paragraphs.
  • Check paragraphs against the introduction and thesis statement.

Fine-grained details

Check the content of each paragraph, making sure that:

  • each sentence helps support the topic sentence.
  • no unnecessary or irrelevant information is present.
  • all technical terms your audience might not know are identified.

Next, think about sentence structure , grammatical errors, and formatting . Check that you have correctly used transition words and phrases to show the connections between your ideas. Look for typos, cut unnecessary words, and check for consistency in aspects such as heading formatting and spellings .

Finally, you need to make sure your paper is correctly formatted according to the rules of the citation style you are using. For example, you might need to include an MLA heading  or create an APA title page .

Scribbr’s professional editors can help with the revision process with our award-winning proofreading services.

Discover our paper editing service

Checklist: Research paper

I have followed all instructions in the assignment sheet.

My introduction presents my topic in an engaging way and provides necessary background information.

My introduction presents a clear, focused research problem and/or thesis statement .

My paper is logically organized using paragraphs and (if relevant) section headings .

Each paragraph is clearly focused on one central idea, expressed in a clear topic sentence .

Each paragraph is relevant to my research problem or thesis statement.

I have used appropriate transitions  to clarify the connections between sections, paragraphs, and sentences.

My conclusion provides a concise answer to the research question or emphasizes how the thesis has been supported.

My conclusion shows how my research has contributed to knowledge or understanding of my topic.

My conclusion does not present any new points or information essential to my argument.

I have provided an in-text citation every time I refer to ideas or information from a source.

I have included a reference list at the end of my paper, consistently formatted according to a specific citation style .

I have thoroughly revised my paper and addressed any feedback from my professor or supervisor.

I have followed all formatting guidelines (page numbers, headers, spacing, etc.).

You've written a great paper. Make sure it's perfect with the help of a Scribbr editor!

Open Google Slides Download PowerPoint

Is this article helpful?

Other students also liked.

  • Writing a Research Paper Introduction | Step-by-Step Guide
  • Writing a Research Paper Conclusion | Step-by-Step Guide
  • Research Paper Format | APA, MLA, & Chicago Templates

More interesting articles

  • Academic Paragraph Structure | Step-by-Step Guide & Examples
  • Checklist: Writing a Great Research Paper
  • How to Create a Structured Research Paper Outline | Example
  • How to Write a Discussion Section | Tips & Examples
  • How to Write Recommendations in Research | Examples & Tips
  • How to Write Topic Sentences | 4 Steps, Examples & Purpose
  • Research Paper Appendix | Example & Templates
  • Research Paper Damage Control | Managing a Broken Argument
  • What Is a Theoretical Framework? | Guide to Organizing

What is your plagiarism score?

Library homepage

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

selected template will load here

This action is not available.

Humanities LibreTexts

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 writing academic paper

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.

What is Technical Writing?

What is Technical Writing?

Table of Contents

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 .

young-woman-technical-writing-at-home

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. 

Technical-Writing-Guide-CTA

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. 

Related Articles

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.

Guide-to-Business-Writing-CTA

  • Business Writing Skills (54)
  • Business Grammar (52)
  • Technical Writing (30)
  • 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 (132)
  • Samantha Taylor (2)
  • Terrance Collins (1)
  • Tom DuPuis (10)

Elsevier QRcode Wechat

  • Research Process

Making Technical Writing in Environmental Engineering Accessible

  • 4 minute read

Table of Contents

Research in Environmental Engineering offers solutions to many pressing global issues including climate change, pollution 1 , waste disposal 1 , loss of biodiversity etc. However, the people implementing this research (government agencies, lawmakers, etc.) may find it hard to understand the technical language of Environmental Engineering papers.

Elsevier Language Editing Services has therefore compiled a list of tips for researchers in Environmental Engineering, to help improve the accessibility of their papers.

What makes writing an Environmental Engineering paper hard?

Students of this discipline tend to be more comfortable with numbers and equations 2 ; moreover, the nature of their work is quite technical. Writing longer form content (like academic papers) in a simple format may often be challenging for these students.

Why must Environmental Engineering papers be accessible?

Making Environmental Engineering papers more accessible can make the field more collaborative, make translating research into solutions easier, and could contribute to your success as a researcher!

Tips for Better Communicating Environmental Engineering Research

1. Lower the threshold for understanding professional content

Keep your audience in mind, and make sure you make your writing engaging for them 3 . Minimize the use of jargon, use simple examples 3 , and refer to contemporary issues to communicate the relevance of your work.

For example:

  • Instead of saying ‘ anthropogenic climate change’ , say ‘ human-induced climate change’ , since that is a less technical phrase .
  • Instead of saying ‘ abnormal temperatures contribute towards climate change-related mortality’ , say ‘ the abnormal temperatures caused by climate change contribute to over five million more deaths a year’ 4 . The second sentence is clearer and easier to understand for someone who is not used to scientific terminologies like “mortality”.

2. Use visualization tools

Illustrations and graphs can help explain concepts 3 . Keep these as non-technical and as simple as possible. You can also use a diagram to collate many ideas into a “bigger picture”.

When your findings prominently feature numbers, use a simple graph:

  • Asia accounted for 41% of the global iron consumption in 1995, but it rose to 64% by 2010. The consumption of copper rose from 32% to 60% and that of nickel from 34% to 54% during the same period 5 . This information can be summed up in a bar graph like so:

Global share of apparent consumption

  • The most common patented bioremediation agents are bacteria (57%), enzymes (19%), fungi (13%), algae (6%), plants (4%) and protozoa 6 . This information can be presented succinctly as a donut chart:

donat chart of patented bioremediation agents are bacteria (57%), enzymes (19%), fungi (13%), algae (6%), plants (4%) and protozoa

To explain processes, use a flow chart:

technical writing academic paper

3. Improve the flow of your content itself

Plan the overall structure of your paper to ensure that you include all the necessary information while maintaining a natural progression of ideas 2,3 . It is best to start with general statements and set context before moving on to specifics.

An increasing number of people are living in high rise buildings 7

High rise buildings are known to create “hotspots” of high pollutant concentrations 7

We developed a fluid dynamics model to explore the creation of pollution hotspots 7

technical writing academic paper

Plastic is one of the most persistent environmental pollutants 8

Using plastic to pave roads is one way to manage plastic waste 8

This study reviewed the effect of plastic on the stability and performance of asphalt 8

technical writing academic paper

In both instances, structuring your paragraph allows the reader to absorb the information in a logical way, offering clarity as to the chronological order and links between events and tying them together.

Above, we have explained three tips for researchers in Environmental Engineering. If you need more specific professional advice on the optimization of the overall structure of your article and the refinement of words and sentences, you can seek high-quality assistance from Elsevier Language Editing Services.

Elsevier Language Editing Services’ editorial team has rich experience in paper polishing for manuscripts in more than 100 disciplines, including Environmental Engineering. Our team can tailor a more targeted service plan to meet your specific needs and those of your article. We will deliver a professional and readable article, increasing the probability of publication, and helping you exercise a wider scientific research influence!

References:

  • Environmental Engineering. (n.d.). Civil Engineering. https://www.mcgill.ca/civil/undergrad/areas/environmental .
  • Fezari, M., & Dahoud, A. A. (2018). Guide and Hints to write engineering research paper. ResearchGate. https://www.researchgate.net/publication/327831767_Guide_and_Hints_to_write_engineering_research_paper
  • Library Guides: Civil and Environmental Engineering: Ten tips for Technical writing. (n.d.). https://guides.libraries.psu.edu/c.php?g=375828&p=8995865 .
  • World’s largest study of global climate related mortality links 5 mill. (2021b, July 8). Monash University. https://www.monash.edu/news/articles/worlds-largest-study-of-global-climate-related-mortality-links-5-million-deaths-a-year-to-abnormal-temperatures
  • Nakajima, K., Daigo, I., Nansai, K., Matsubae, K., Takayanagi, W., Tomita, M., & Matsuno, Y. (2018). Global distribution of material consumption: Nickel, copper, and iron. Resources Conservation and Recycling , 133, 369–374. https://doi.org/10.1016/j.resconrec.2017.08.029 .
  • Quintella, C. M., Mata, A. M., & Lima, L. (2019). Overview of bioremediation with technology assessment and emphasis on fungal bioremediation of oil contaminated soils. Journal of Environmental Management , 241, 156–166. https://doi.org/10.1016/j.jenvman.2019.04.019 .
  • Aristodemou, E., Boganegra, L. M., Mottet, L., Pavlidis, D., Constantinou, A., Pain, C. C., Robins, A., & ApSimon, H. (2018). How tall buildings affect turbulent air flows and dispersion of pollution within a neighbourhood. Environmental Pollution , 233, 782–796. https://doi.org/10.1016/j.envpol.2017.10.041 .
  • Ma, Y., Zhou, H., Jiang, X., Polaczyk, P., Xiao, R., Zhang, M., & Huang, B. (2021). The utilization of waste plastics in asphalt pavements: A review. Cleaner Materials , 2, 100031. https://doi.org/10.1016/j.clema.2021.100031 .

There are some recognizable elements and patterns often used for framing engaging sentences in English. Find here the sentence patterns in Academic Writing

  • Manuscript Preparation

Changing Lines: Sentence Patterns in Academic Writing

Doctor doing a Biomedical Research Paper

Five Common Mistakes to Avoid When Writing a Biomedical Research Paper

You may also like.

what is a descriptive research design

Descriptive Research Design and Its Myriad Uses

Doctor doing a Biomedical Research Paper

To Err is Not Human: The Dangers of AI-assisted Academic Writing

Importance-of-Data-Collection

When Data Speak, Listen: Importance of Data Collection and Analysis Methods

choosing the Right Research Methodology

Choosing the Right Research Methodology: A Guide for Researchers

Why is data validation important in research

Why is data validation important in research?

Writing a good review article

Writing a good review article

Scholarly Sources What are They and Where can You Find Them

Scholarly Sources: What are They and Where can You Find Them?

Input your search keywords and press Enter.

technical writing academic paper

Academia.edu no longer supports Internet Explorer.

To browse Academia.edu and the wider internet faster and more securely, please take a few seconds to  upgrade your browser .

  •  We're Hiring!
  •  Help Center

Technical Writing

  • Most Cited Papers
  • Most Downloaded Papers
  • Newest Papers
  • Save to Library
  • Last »
  • Technical Communication Follow Following
  • Professional Writing Follow Following
  • Composition and Rhetoric Follow Following
  • Rhetoric Follow Following
  • Professional Communication Follow Following
  • Scientific and Technical Communication Follow Following
  • Writing Program Administration Follow Following
  • Digital Rhetorics Follow Following
  • Communication Research Follow Following
  • Rhetorical Theory Follow Following

Enter the email address you signed up with and we'll email you a reset link.

  • Academia.edu Publishing
  •   We're Hiring!
  •   Help Center
  • Find new research papers in:
  • Health Sciences
  • Earth Sciences
  • Cognitive Science
  • Mathematics
  • Computer Science
  • Academia ©2024

We use cookies to provide you with a good service. By using this website, you agree with our Cookie policy. Read more .

Logo College Writers

Technical Writing VS Academic Writing: What’s the Difference?

There are many types of writing. For example, there are technical writing and academic writing. Experienced professionals from College-Writers.com say some students think these two types of writing are similar, the truth is that these are two completely different categories.

Technical & Academic: Definitions

It may seem that academic writing should be more complicated and difficult because it is focused on some specific and narrow discipline. Indeed, this type of writing is often associated with the use of specific jargon. In addition, academic writing may describe very complicated concepts and provide specialized knowledge. However, technical writing may also contain jargon used in a certain industry.

As the name suggests, technical writing is intended to describe technical information. It may be focused on scientific subjects, engineering, etc. The term “technical writing” is used when referring to articles, training materials, documents, etc.

Technical writing may vary depending on the specifics of a particular industry. For instance, when you have to write documentation for hardware, this task is completely different from writing about software. Technical writing is also used in many other industries, including pharmaceutical, manufacturing, and so on.

Manufacturing enterprises and other organizations aim to satisfy customers delivering top-notch products and services. Thus, these companies put a lot of effort into ensuring comfort and safety. However, they also should have quality support documentation. Technical writers create such sorts of documentation in order to fulfill the needs of the company.

Different Objectives

Technical writing and academic writing also have completely different purposes. Academic writing is aimed to present a certain point of view on a particular subject. Academic papers present results of research and demonstrate someone’s knowledge. In turn, technical writing explains something to readers and informs them. Technical papers often explain how to use a certain product or service. Technical documents can also describe procedures used by the manufacturer to perform certain tasks. What technical and academic writing have in common is that both types may contain jargon.

Audiences Are Different

Academic and technical writing also target different audiences. Academic papers are usually intended for fellow scholars. However, there are also academic pieces of writing intended for a wide audience.

Technical writing is intended for people who use the product or service. Quite often, this type of writing is also aimed for government inspectors or people responsible for specific tasks.

What Should I Choose?

As you can see, it makes sense to choose a style depending on your audience. Actually, knowing the audience is the main rule of the writing of any kind. Once you’ve determined the audience, you can proceed to choose your style of writing. For example, if you need to write an article for an academic journal, you should stick with the academic style. On the other hand, if you need to write a manual on some gadget, the technical style will obviously be the best choice. The right style will help your readers understand all the necessary details.

Think of the Impact

Think of who will read your paper and ask yourself, what is your main goal? Your style may vary depending on what you want to accomplish. For example, if you’re writing for the general audience, which is quite diverse, you should choose the technical style. On the other hand, if you want to persuade your readers, the academic style will be a better choice. Academic writing enables you to provide reasons, evidence, and various details related to your assumption. If you want to persuade your readers, put more effort into writing a strong conclusion that will make an impact.

Career Options

If you become a technical writer, you will be able to find jobs in various industries, including pharmaceutical, IT, manufacturing, etc. There are many companies from all over the world that look for talented technical writers who can describe their devices and technical processes. You can also choose some narrow niche, for example, a certain type of software or hardware, and work in this area.

Academic writers should have better writing skills in order to write academic articles. Academic writers can also work as thesis writers, essay writers, dissertation writers, and so on. If you choose to work in the academic field, you will write white papers, research reports, and many other types of academic papers.

With us you get

  • 10+ years experience in the custom writing market
  • A wide range of services
  • Satisfied and returning customers
  • 6-hour delivery available
  • Money-back guarantee
  • 100% privacy guaranteed
  • Professional team of experienced paper writers
  • Only custom college papers
  • Free amendments upon request
  • Constant access to your paper writer
  • Free extras by your request

Jdocs Logo

Technical Writing vs. Academic Writing: What’s the Difference?

technical writing academic paper

Technical writing and academic writing are different from each other, and a student needs to know what sets them apart. With technical writing, the content of this nature highlights lucid and detailed information regarding a particular service or product.

The things that a student should talk about should be straight to the point, factual, and nothing should be made up. The way that goals should be accomplished should take center stage when it comes to this content, and students should avoid giving their point of view on a specific matter.

When it comes to academic writing, this is content that has everything to do with proving theories or opinions in different ways while sticking to one subject Even though its main goal is to prove a point, most of the information that goes into it is based on academic research conducted by a student or an academic writing service with professional essay writers.

Major differences between technical writing and academic writing

1.     different target audiences.

People all across the world have different tastes in things like movies and music, it is all about preference. The same logic also applies when it comes to written content, where some people will enjoy reading academic pieces while some will prefer technical pieces.

This point above is very obvious and isn’t surprising because they are different forms of writing and will cater to different audiences. Academic writing is more catered to people who are in school, but some pieces written can be used by working professionals in different fields.

Technical writing on the other hand is for people who use a particular product or service. In other words, this content is for people who hold positions like inspectors, management, investors, and more.

2.     Different career choices

The second notable difference between academic writing and technical writing is the career path that one takes. Just like the point above, preference also plays a very important role in the direction a student or a professional takes in terms of their career, depending on the content they like to read.

Academic writing services say if a student chooses technical writing as a career choice, they will be able to land jobs in the manufacturing, IT, and pharmaceutical industries just to name a few. Many companies across the globe are looking for amazing technical writers who can talk about their devices and technological methods.

Academic writing on the other hand requires a student to be very versatile because they need to write dissertations, essays, reports, proposals, research papers, and more. A career in this form of writing means a student has to produce content for the papers mentioned above.

3.     Different end goals

Both academic writing and technical writing try to accomplish something different according to online writing services. It would not make any sense to anyone if the two different writing styles achieved the same thing or had the same end goal.

For instance, academic writing is where a student tries to present certain viewpoints on a subject. The papers produced show the knowledge a student has as well as the results of research conducted.

Technical writing on the other hand illustrates how a service or product is used. It is very informative and these are documents that show manufacturer instructions and how tasks are performed. The only thing that a technical writer has in common with academic writing is they both have jargon.

Even though using jargon is perfectly acceptable, it is important for the people writing to use the correct ones at all times because using the wrong one can lead to their message being misinterpreted or lost in translation. If any new words are used in a particular piece that the writer might think the audience might not be aware of, they can define them in the footnotes.

4.     Different expressions of gathered information

Both academic writing and technical writing will have different ways to express the information that has been researched. The content produced will be completely different from each other, and students need to know the difference in approach.

When someone is writing a technical paper, they are not allowed to give their viewpoints, while in academic writing the case is different. Students can include their viewpoints and theories, allowing for more freedom of expression. They will not get penalized or deducted marks for this.

Technical writing is all about providing detailed information about a service or a product to readers. On top of that, academic writing will have certain information on a particular field of study, while technical writing is all about straightforward content that is backed up by facts.

When backing up the content with facts, the writer needs to make sure that the information is not stolen from other sources and presented differently. This is known as plagiarism and in the writing world, this is a serious offense that can make a writer lose their credibility and have a bad reputation, which is the last thing they need. Content produced has to be 100% original at all times to avoid getting into problems.

5.     Different sets of knowledge

The other area where academic writing and technical writing differ is when it comes to knowledge. According to many paper writing services, they say that people who are involved in academic writing have what is known as learner’s knowledge.

People who focus on technical writing have what is known as expert knowledge because these are people with so many years of experience under their belt in a specific field. It is also worth pointing out that in academic writing, the knowledge of a sordid topic is smaller than the tutor who will be marking the paper.

Speaking of technical writing, professional writing services say the knowledge is larger than the person who will be reading it. Overall, the main goal of academic writing is to get the paper topic done, while technical writing is all about demonstrating that the writer knows the topic very well.

6.     Use of graphics

When college or university students are writing an academic paper, they can use numbers and charts to get their point across. In a technical paper, on the other hand, numbers, and charts are used to support the conclusion made.

Final thoughts

From the points above, it is clear to see that the writing style a student or paper writing service goes for depends on the target audience. Knowing the intended audience is the first thing a student must do before they begin writing any of the two types of writing styles. Once they know what their audience is, they can begin piecing the content together because using the wrong style for the wrong audience can lead to confusion and messages being lost in translation.

About Author

' src=

Michael Smith

See author's posts

Related Posts

Agile Testing

How Do You Apply Agile Testing Principles And Practices Across Different Domains And Contexts?

What Are The Benefits And Challenges Of Using Mock Objects In TDD

What Are The Benefits And Challenges Of Using Mock Objects In TDD?

Data-Driven Test Results

What Are The Best Practices For Validating And Verifying Data-Driven Test Results

Serverless Development with Feather.js and AWS Lambda

Leveraging Scalability: Serverless Development with Feather.js and AWS Lambda

Best Practices for Effective Software Staff Augmentation

Best Practices for Effective Software Staff Augmentation

purpose-of-a-software-company

Unveiling the Core Objectives: The Purpose of a Software Company

  • Software Testing Tutorial
  • Levels of Software Testing
  • Software Testing Techniques
  • Test plan – Software Testing
  • Software Testing Tools
  • Backend Testing
  • API Testing
  • Apache JMeter
  • Agile Software Testing
  • Selenium Basics

Related Articles

  • JPanel vs JFrame
  • Difference between Information System and Information Technology
  • Blender vs Maya
  • Chef vs Puppet
  • Kibana vs Splunk
  • Difference between Desktop publishing (DTP) and Word Processor Software
  • Difference between Inspection and Walkthrough
  • Difference between N-version programming and Recovery blocks Techniques
  • Difference between JPEG and PSD
  • Difference between RCM and RCA
  • Difference between Personal and Professional Ethics
  • Difference between Technical Writing and General Writing
  • Difference between Generic Software Development and Custom Software Development
  • Difference between Technical Writing and Creative Writing
  • Difference between Corporate Communication and Marketing Communication
  • Difference between MRP and MPS
  • Difference between E-commerce and Retail
  • Difference between Difference Engine and Analytical Engine
  • Difference between Top Down and Bottom Up Integration Testing

Difference between Technical Writing and Academic Writing

1. Technical Writing : Technical writing refers to a piece of writing which focuses on providing detailed and lucid information about the product or service. It contains factual and straight forward content. It is entirely goal-oriented and it talks about different ways by which the desired goal can be achieved. Mainly Technical writings are something new or existing concept based on the same technical domain. Here the writer avoids to explain a specific subject matter by providing his/her own point of view. 

Example includes suppose a writer writing a article based on the topic comes under computer science domain on GeeksforGeeks. 

2. Academic Writing : Academic writing refers to a piece of writing which focuses on proving a theory or viewpoint in one way or the other and emphasizes upon one specific subject. Through academic writing the writer intends to prove a theory or viewpoint in one way or the other. Mainly academic writings are based on academic findings and academic research. The writer can explain a specific subject matter by providing his/her own point of view. 

Example includes suppose a professor writing on a concept related to Chemistry and that published on college’s monthly magazine. 

Difference between Technical Writing and Academic Writing :

Please Login to comment...

  • Difference Between
  • Software Engineering
  • abdulbasit3909

Improve your Coding Skills with Practice

 alt=

What kind of Experience do you want to share?

IMAGES

  1. (PDF) HOW TO WRITE AN ACADEMIC RESEARCH PAPER

    technical writing academic paper

  2. computer science technical writing example

    technical writing academic paper

  3. Reflective Essay: Ieee technical paper example

    technical writing academic paper

  4. 😍 Examples of technical writing for students. Importance Of Technical

    technical writing academic paper

  5. Technical document writer

    technical writing academic paper

  6. Calaméo

    technical writing academic paper

VIDEO

  1. Research Paper Writing online Workshop

  2. Proofread File

  3. Academic Writing Complete Course: academic writing for beginners

  4. Roles and Responsibilities of Technical Writer

  5. Writing Space

  6. TUTORIAL 1: CONTENT AND STYLE OF AN ACADEMIC PAPER

COMMENTS

  1. Basics of scientific and technical writing

    Three major types of scientific/technical writing covered in the three-part series. Full size image Papers The publication of papers is a standard way to share knowledge and transfer methods in scientific communities, thus a pivotal part of any research activity, especially in an academic environment.

  2. Professional, Technical Writing

    Purdue OWL Subject-Specific Writing Professional, Technical Writing Professional, Technical Writing Professional, Technical Writing These OWL resources will help you conduct research and compose documents for the workplace, such as memoranda and business letters. This section also includes resources for writing report and scientific abstracts.

  3. Tips for Writing Technical Papers

    ( Exercise: Write an abstract for the multiway sort example.) the Introduction is crucially important. Why is it interesting and important? (E.g., why do naive approaches fail?) Why hasn't it been solved before? What are the key components of my approach and results? Also include any specific limitations.

  4. Technical Writing Standards

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

  5. How to write a technical paper or a research paper

    Know your message, and stay on message. The goal of writing a paper is to change people's behavior: for instance, to change the way they think about a research problem or to convince them to use a new approach. Determine your goal (also known as your thesis), and focus the paper around that goal.

  6. Journal of Technical Writing and Communication: Sage Journals

    SUBMIT PAPER. The Journal of Technical Writing and Communication (JTWC) is one of several prestigious international scholarly journals in the field of technical and professional communications. Published quarterly, JTWC strives to meet the diverse … | View full journal description. This journal is a member of the Committee on Publication ...

  7. How to Write a Technical Paper or a Research Paper

    26-Oct-2023 Writing a technical or research paper can be both a tricky and enjoyable experience. It's an essential skill for researchers, scientists, and academics, as it allows you to communicate your findings and contribute to the world of knowledge. However, the question that arises is: How to write a technical paper?

  8. 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 ...

  9. What Is Academic Writing?

    Academic writing is a formal style of writing used in universities and scholarly publications. You'll encounter it in journal articles and books on academic topics, and you'll be expected to write your essays, research papers, and dissertation in academic style. Academic writing follows the same writing process as other types of texts, but ...

  10. Introduction to Technical Writing

    There are 4 modules in this course. 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 ...

  11. How to Write a Research Paper

    A research paper is a piece of academic writing that provides analysis, interpretation, and argument based on in-depth independent research. Research papers are similar to academic essays, but they are usually longer and more detailed assignments, designed to assess not only your writing skills but also your skills in scholarly research.

  12. PDF Technical writing tutorial

    Purpose: To learn how to communicate technical information in writing. Importance: The main modes of communication are written, verbal, and visual. As a scientist or engineer, you will want to share your work. This is commonly done through thesis, journal papers, and books. This type of writing has a different purpose than creative story ...

  13. 1: Introduction to Technical Writing

    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. ... Physical features: These include paper, which may take many shapes and sizes, and bindings, which come in ...

  14. (PDF) Scientific and Technical Writing

    In some technical and scientific writing situations, professional writers need to work with subject-matter specialists to produce documents of various kinds (Lee & Mehlenbacher 2000; Lagnado 2003).

  15. PDF The Structure of an Academic Paper

    Simone A. Fried, TF Spring 2021 The Structure of an Academic Paper Academic papers are like hourglasses. The paper opens at its widest point; the introduction makes broad connections to the reader's interests, hoping they will be persuaded to follow along, then gradually narrows to a tight, focused, thesis statement.

  16. What is Technical Writing? [A New Definition]

    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. New definition of technical writing

  17. Making Technical Writing in Environmental Engineering Accessible

    What makes writing an Environmental Engineering paper hard? Students of this discipline tend to be more comfortable with numbers and equations 2; moreover, the nature of their work is quite technical. Writing longer form content (like academic papers) in a simple format may often be challenging for these students.

  18. PDF ACADEMIC WRITING

    exceptions to the rules in academic writing. - Practicums: These boxes give step-by-step instructions to help you build ideas and write papers. - The Writing Process: These features show all the steps taken to write a paper, allowing you to follow it from initial idea to published article.

  19. (PDF) Technical Writing

    This technical report aims to define academic and technical writing, describes the importance of it, and classify the technical writing, showing their types and importance of each type. ... P age 2.2 Paragraph 2.2.1 Definition The Paragraph is the building blocks of any paper, it consists of a group of sentences at least five sentences and they ...

  20. Technical Writing Research Papers

    View Technical Writing Research Papers on Academia.edu for free.

  21. Technical Writing VS Academic Writing: What's the Difference?

    Academic papers present results of research and demonstrate someone's knowledge. In turn, technical writing explains something to readers and informs them. Technical papers often explain how to use a certain product or service. Technical documents can also describe procedures used by the manufacturer to perform certain tasks.

  22. Technical Writing and Academic Writing: What's the Difference?

    Michael Smith 2 years ago 5 min read Technical writing and academic writing are different from each other, and a student needs to know what sets them apart. With technical writing, the content of this nature highlights lucid and detailed information regarding a particular service or product.

  23. Difference between Technical Writing and Academic Writing

    Difference between Technical Writing and Academic Writing Read Courses 1. Technical Writing : Technical writing refers to a piece of writing which focuses on providing detailed and lucid information about the product or service. It contains factual and straight forward content.