Research in Technical Writing

      Technical communication requires writers to take on a variety of roles, as well as to develop and maintain a multitude of skills.  The technical writer must be a surveyor and a translator, and perhaps most important, a researcher.  According to Booth, Colomb & Williams (2008), a technical writer filling the role of a researcher, must understand “not only how to find information, but how to evaluate it, then report it clearly and accurately” (p. 3). 

      This article will briefly touch upon the most basic (and important) elements of effective research in technical writing.  It will explain (a) what types of sources are available, (b) where to find them, (c) how to properly cite sources, (d) how to avoid plagiarism, and (e) how to determine the credibility of sources. 

Primary and Secondary Sources

Before composing a technical document, it is important to decide what types of sources to use.  According to Smith-Worthington and Jefferson (2011), primary and secondary sources are the two basic types of information utilized in technical writing.  Primary sources “are direct or firsthand reports of facts or observations” (Smith-Worthington & Jefferson, 2011, p. 46). Interviews, observations, or the writer’s own experiences are common examples of primary sources.  Secondary sources “are indirect or second hand reports of information” (Smith-Worthington & Jefferson, 2011, p. 46).  Examples of secondary sources include books, pamphlets, articles, and websites. 

When composing your document, it’s smart to start with secondary sources that can provide you with background information on the topic.

 Secondary sources can be found just about everywhere:

·      company archives

·      the library

·      bookstores

·      newspaper and journal periodicals; and

·      online databases.

 For help in learning how to effectively search topics in databases, refer to “how-to” lessons provided by the organization.  For instance, ask a librarian for help searching for books, or click on the “help” link of an online database to guide you through the process (Smith-Worthington & Jefferson, 2011).  Once you’ve developed a better understanding of the topic through primary sources, you can add your first-hand experience to the content.  Much like academic research writing, technical writing requires you to make your claims and back them up with credible sources.

Documenting Sources

      In any form of writing, and in practically every field of professionalism, it is crucial that a writer properly document sources used.  Properly documenting a source demonstrates your respect for the work of others, and also establishes your own credibility (Rubens, 2001).  In summary, “every time you borrow the words, facts, or ideas of others, you must document the source – that is, supply a reference telling readers that you borrowed the material and where you borrowed it from” (Ashford guide, 2009, p. 312).

      Documenting sources includes the use of:

·      Quotation marks – when directly quoting a source’s exact words (Ashford guide, 2009).

·      In-text citations – providing the last name of the author and date of the source in parentheses after a paraphrase or summary (Ashford guide, 2009).

·      Reference list or bibliography – supplying the complete information of sources (Ashford guide, 2009).

       

Plagiarism

      Failure to properly credit people for their work results in a serious offense called plagiarism.  According to the Ashford guide for academic and career success, “plagiarism is the presentation of someone else’s ideas or words as your own” (2009, p. 306).  Plagiarism may be deliberate or unintentional (Ashford guide, 2009).

      Examples of plagiarism include:

·      Copying the text of a source, word for word, without the use of quotation marks or in-text citations (Rubens, 2001).

·      Paraphrasing the words of a source without proper citation (Ashford guide, 2009).

·      Using someone else’s complete works as your own (Ashford guide, 2009).

·      Omitting a source citation from your work (Ashford guide, 2009).

·      Forgetting, or not knowing how to properly cite a source (Ashford guide, 2009).

If in any instance you are unsure whether or not you should cite a source, cite it, simply as a precautionary measure (Rubens, 2001).

Evaluating Resources For Credibility

      Not all sources are created alike.  In fact, there are many sources that fail to demonstrate credibility in today’s “age of information (or too often mis information)” (Booth, Colomb & Williams, 2008, p. 3).  While some mediums are generally more credible that others, it is immensely important that all resources be evaluated for credibility before using them.  

      Tips for establishing credibility of sources include:

·      Check the publisher – reputable companies publish credible works (Booth, Colomb & Williams, 2008).

·      Check for a peer-review conducted by experts on the topic (Booth, Colomb & Williams, 2008).

·      Research the author – are they reputable, respected scholars? (Booth, Colomb & Williams, 2008).

·      Check the publication date – is it current? (Booth, Colomb & Williams, 2008).

      Technical writing is all about accurate data, thus it is crucial that the sources you utilize are valuable and credible.  If ever a source appears unreliable, discard it, and search elsewhere.  Unreliable sources can damage your writing – and your reputation as a technical writer. 

      Conducting research for technical writing doesn’t have to be difficult.  Understanding how to properly conduct research can make the process a very enlightening and interesting experience.  Successful technical writers understand the basics of conducting research, and subsequently follow research guidelines to ensure the credibility of their own work, through respecting the work of others. 

References

Ashford guide for academic and career success. (2009). New York, NY: Pearson Custom

      Publishing.

Booth, W. C., Colomb, G. G., & Williams, J. M. (2008). The craft of research. Chicago,

      IL: University of Chicago Press. Retrieved April 1, 2013, from Questia Online

      Library, [Document ID: 118691491].

Rubens, P. (2001). Science and technical writing: A manual of style. New York, NY:

      Routledge. Retrieved March 31, 2013, from Questia Online Library, [Document ID:

      108384346].

Smith-Worthington, D., & Jefferson, S. (2011). Technical writing for success. (3^rd ed.).

      Mason, Ohio: South-Western Cengage Learning.