five best practices for technical writingservicesNitor
What exactly is Technical Writing? What are the types of documents that come under the purview of technical writing? And why do we say that it is it important to follow rules and plan your initiatives?
Technical Writing Annemarie Hamlin, Chris Rubio, Michele DeSilva.docxSANSKAR20
Technical Writing
Annemarie Hamlin, Chris Rubio, Michele DeSilva
Open Oregon Educational Resources
Technical Writing by is licensed under a , except where otherwise noted.
Contents
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
1
AcknowledgementsAbout this free online technical writing textbook
Much of this text, published under a Creative Commons license, was originally developed by Dr. David McMurrey, who is both a technical writer and a college instructor. For more about him and his original work, please visit his biography page at: . He kindly gave his text a CC-BY license at our request so that we could adapt our text from it. We extend our sincere appreciation to Dr. McMurrey, the team of consultants at Saylor University whose is also featured in this text, and the host of educators, librarians, and professionals who
have shared their creations with a Creative Commons license. Our thanks as well to our colleague, Dr. Eleanor Sumpter-Latham, whose work we consulted and adapted into this text.
Additional materials have been adapted or created by Annemarie Hamlin, Chris Rubio, and Michele DeSilva of Central Oregon Community College.
We also extend our gratitude to for the grant funding to pursue this project and especially to Amy Hofer of Open Oregon for her knowledgeable and helpful answers to many questions.
2
External Link Disclaimer
This textbook links to external websites over which the authors have no control. The authors have made efforts to ensure that external links are accurate and operational, but problems are inevitable. If you find a problem, please report it to Michele DeSilva at [email protected]
3
Introduction
Technical writing courses introduce you to some of the most important aspects of writing in the worlds of science, technology, and business—in other words, the kind of
writing that scientists, nurses, doctors, computer specialists, government officials, engineers, and other such people do as a part of their regular work. The skills learned in technical writing courses can be useful in other fields as well, including education and social sciences.
To learn how to write effectively for the professional world, you will study common types of reports, special format items such as lists and headings, simple techniques for creating and using graphics in reports, and some techniques for producing professional-looking final copy.
Technical writing courses build on what you have learned in other writing courses. But there is plenty new to learn! If you currently have a job in which you do some writing, you will discover that you can put what you learn in your technical writing course to immediate use.
About technical writing
While technical communication is essential in a wide range of fields and occupations, technical writing is also a fully professional field of its own wit.
Technical Writing Annemarie Hamlin, Chris Rubio, Michele DeSilva.docxjacqueliner9
Technical Writing
Annemarie Hamlin, Chris Rubio, Michele DeSilva
Open Oregon Educational Resources
Technical Writing by Annemarie Hamlin, Chris Rubio,Michele DeSilvais licensed under a Creative CommonsAttribution-NonCommercial-ShareAlike 4.0 InternationalLicense, except where otherwise noted.
Contents
· Acknowledgements
· External LinkDisclaimer
· Introductioncc-by
· 1. ProfessionalCommunications
· 1.1Texting
· 1.2E-mail
· 1.3Netiquette
· 1.4Memorandums
· 1.5Letters
· 2. AudienceAnalysis
· 2.1 Types ofaudiences
· 2.2 Audienceanalysis
· 2.3 Adapting your writing to meet youraudience’s
needs
· 3.Proposals
· 3.1 Somepreliminaries
· 3.2 Types ofproposals
· 3.3 Typical scenarios for theproposal
· 3.4 Common sections inproposals
· 3.5 Special assignmentrequirements
· 3.6 Proposals andaudience
· 3.7 Revision checklist forproposals
· 4. InformationLiteracy
· 4.1 Informationformats
· 4.2 The informationtimeline
· 4.3 The researchcycle
· 4.4 Researchtools
· 4.5 Searchstrategies
· 4.6 Evaluatesources
· 5. Citations andPlagiarism
· 5.1Citations
· 5.2Plagiarism
· 6. ProgressReports
· 6.1 Functions and Contents of ProgressReports
· 6.2 Timing and Format of ProgressReports
· 6.3 Organizational Patterns or Sectionsfor ProgressReports
· 6.4 Other Parts of ProgressReports
· 6.5 Revision Checklist for ProgressReports
· 7.Outlines
· 7.1 Creating and usingoutlines
· 7.2 Developing the roughoutline
· 8. Creating and IntegratingGraphics
· 8.1 Deciding which graphics toinclude
· 8.2 Other considerations:audience
· 8.3 Other considerations: placement andcontext
· 8.4Samples
· 8.5 Guidelines for graphics: a finalreview
· 9. Ethics in TechnicalWriting
· 9.1 GeneralPrinciples
· 9.2 Presentation ofinformation
· 9.3 Typical Ethics Issues in TechnicalWriting
· 9.4 Ethics and documentingsources
· 9.5 Ethics, Plagiarism, and ReliableSources
· 9.6 Professionalethics
· 10. DocumentDesign
· 10.1 Coverletter
· 10.2 Coverpage
· 10.3 Abstract and executivesummary
· 10.4 Table ofcontents
· 10.5 List of figures andtables
· 10.6 Introduction
· 10.7 Body of thereport
1
AcknowledgementsAbout this free online technical writing textbook
Much of this text, published under a Creative Commons license, was originally developed by Dr. David McMurrey, who is both a technical writer and a college instructor. For more about him and his original work, please visit his biography page at: https://www.prismnet.com/~hcexres/index.html. He kindly gave his text a CC-BY license at our request so that we could adapt our text from it. We extend our sincere appreciation to Dr. McMurrey, the team of consultants at Saylor University whose work shared viaopen educational resourcesis also featured in this text, and the host of educators, librarians, and professionals who
have shared their creations with a Creative Commons license. Our thanks as well to our colleague, Dr. Eleanor Sumpter-Latham, whose work we consulted and adapted into this text.
Additional materials have been adapted or created by An.
five best practices for technical writingservicesNitor
What exactly is Technical Writing? What are the types of documents that come under the purview of technical writing? And why do we say that it is it important to follow rules and plan your initiatives?
Technical Writing Annemarie Hamlin, Chris Rubio, Michele DeSilva.docxSANSKAR20
Technical Writing
Annemarie Hamlin, Chris Rubio, Michele DeSilva
Open Oregon Educational Resources
Technical Writing by is licensed under a , except where otherwise noted.
Contents
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
1
AcknowledgementsAbout this free online technical writing textbook
Much of this text, published under a Creative Commons license, was originally developed by Dr. David McMurrey, who is both a technical writer and a college instructor. For more about him and his original work, please visit his biography page at: . He kindly gave his text a CC-BY license at our request so that we could adapt our text from it. We extend our sincere appreciation to Dr. McMurrey, the team of consultants at Saylor University whose is also featured in this text, and the host of educators, librarians, and professionals who
have shared their creations with a Creative Commons license. Our thanks as well to our colleague, Dr. Eleanor Sumpter-Latham, whose work we consulted and adapted into this text.
Additional materials have been adapted or created by Annemarie Hamlin, Chris Rubio, and Michele DeSilva of Central Oregon Community College.
We also extend our gratitude to for the grant funding to pursue this project and especially to Amy Hofer of Open Oregon for her knowledgeable and helpful answers to many questions.
2
External Link Disclaimer
This textbook links to external websites over which the authors have no control. The authors have made efforts to ensure that external links are accurate and operational, but problems are inevitable. If you find a problem, please report it to Michele DeSilva at [email protected]
3
Introduction
Technical writing courses introduce you to some of the most important aspects of writing in the worlds of science, technology, and business—in other words, the kind of
writing that scientists, nurses, doctors, computer specialists, government officials, engineers, and other such people do as a part of their regular work. The skills learned in technical writing courses can be useful in other fields as well, including education and social sciences.
To learn how to write effectively for the professional world, you will study common types of reports, special format items such as lists and headings, simple techniques for creating and using graphics in reports, and some techniques for producing professional-looking final copy.
Technical writing courses build on what you have learned in other writing courses. But there is plenty new to learn! If you currently have a job in which you do some writing, you will discover that you can put what you learn in your technical writing course to immediate use.
About technical writing
While technical communication is essential in a wide range of fields and occupations, technical writing is also a fully professional field of its own wit.
Technical Writing Annemarie Hamlin, Chris Rubio, Michele DeSilva.docxjacqueliner9
Technical Writing
Annemarie Hamlin, Chris Rubio, Michele DeSilva
Open Oregon Educational Resources
Technical Writing by Annemarie Hamlin, Chris Rubio,Michele DeSilvais licensed under a Creative CommonsAttribution-NonCommercial-ShareAlike 4.0 InternationalLicense, except where otherwise noted.
Contents
· Acknowledgements
· External LinkDisclaimer
· Introductioncc-by
· 1. ProfessionalCommunications
· 1.1Texting
· 1.2E-mail
· 1.3Netiquette
· 1.4Memorandums
· 1.5Letters
· 2. AudienceAnalysis
· 2.1 Types ofaudiences
· 2.2 Audienceanalysis
· 2.3 Adapting your writing to meet youraudience’s
needs
· 3.Proposals
· 3.1 Somepreliminaries
· 3.2 Types ofproposals
· 3.3 Typical scenarios for theproposal
· 3.4 Common sections inproposals
· 3.5 Special assignmentrequirements
· 3.6 Proposals andaudience
· 3.7 Revision checklist forproposals
· 4. InformationLiteracy
· 4.1 Informationformats
· 4.2 The informationtimeline
· 4.3 The researchcycle
· 4.4 Researchtools
· 4.5 Searchstrategies
· 4.6 Evaluatesources
· 5. Citations andPlagiarism
· 5.1Citations
· 5.2Plagiarism
· 6. ProgressReports
· 6.1 Functions and Contents of ProgressReports
· 6.2 Timing and Format of ProgressReports
· 6.3 Organizational Patterns or Sectionsfor ProgressReports
· 6.4 Other Parts of ProgressReports
· 6.5 Revision Checklist for ProgressReports
· 7.Outlines
· 7.1 Creating and usingoutlines
· 7.2 Developing the roughoutline
· 8. Creating and IntegratingGraphics
· 8.1 Deciding which graphics toinclude
· 8.2 Other considerations:audience
· 8.3 Other considerations: placement andcontext
· 8.4Samples
· 8.5 Guidelines for graphics: a finalreview
· 9. Ethics in TechnicalWriting
· 9.1 GeneralPrinciples
· 9.2 Presentation ofinformation
· 9.3 Typical Ethics Issues in TechnicalWriting
· 9.4 Ethics and documentingsources
· 9.5 Ethics, Plagiarism, and ReliableSources
· 9.6 Professionalethics
· 10. DocumentDesign
· 10.1 Coverletter
· 10.2 Coverpage
· 10.3 Abstract and executivesummary
· 10.4 Table ofcontents
· 10.5 List of figures andtables
· 10.6 Introduction
· 10.7 Body of thereport
1
AcknowledgementsAbout this free online technical writing textbook
Much of this text, published under a Creative Commons license, was originally developed by Dr. David McMurrey, who is both a technical writer and a college instructor. For more about him and his original work, please visit his biography page at: https://www.prismnet.com/~hcexres/index.html. He kindly gave his text a CC-BY license at our request so that we could adapt our text from it. We extend our sincere appreciation to Dr. McMurrey, the team of consultants at Saylor University whose work shared viaopen educational resourcesis also featured in this text, and the host of educators, librarians, and professionals who
have shared their creations with a Creative Commons license. Our thanks as well to our colleague, Dr. Eleanor Sumpter-Latham, whose work we consulted and adapted into this text.
Additional materials have been adapted or created by An.
Professional Communication in Computing - WritingUpekha Vandebona
About Writing
This discusses the difference between expository writing and technical writing. Also it highlights how to write user documents for information systems.
Technical writing is straightforward, easy to understand explanations and/or instructions dealing with a particular subject. It is an efficient and clear way of explaining something and how it works.
Professional Communication in Computing - WritingUpekha Vandebona
About Writing
This discusses the difference between expository writing and technical writing. Also it highlights how to write user documents for information systems.
Technical writing is straightforward, easy to understand explanations and/or instructions dealing with a particular subject. It is an efficient and clear way of explaining something and how it works.
Technoblade The Legacy of a Minecraft Legend.Techno Merch
Technoblade, born Alex on June 1, 1999, was a legendary Minecraft YouTuber known for his sharp wit and exceptional PvP skills. Starting his channel in 2013, he gained nearly 11 million subscribers. His private battle with metastatic sarcoma ended in June 2022, but his enduring legacy continues to inspire millions.
Can AI do good? at 'offtheCanvas' India HCI preludeAlan Dix
Invited talk at 'offtheCanvas' IndiaHCI prelude, 29th June 2024.
https://www.alandix.com/academic/talks/offtheCanvas-IndiaHCI2024/
The world is being changed fundamentally by AI and we are constantly faced with newspaper headlines about its harmful effects. However, there is also the potential to both ameliorate theses harms and use the new abilities of AI to transform society for the good. Can you make the difference?
PDF SubmissionDigital Marketing Institute in NoidaPoojaSaini954651
https://www.safalta.com/online-digital-marketing/advance-digital-marketing-training-in-noidaTop Digital Marketing Institute in Noida: Boost Your Career Fast
[3:29 am, 30/05/2024] +91 83818 43552: Safalta Digital Marketing Institute in Noida also provides advanced classes for individuals seeking to develop their expertise and skills in this field. These classes, led by industry experts with vast experience, focus on specific aspects of digital marketing such as advanced SEO strategies, sophisticated content creation techniques, and data-driven analytics.
Between Filth and Fortune- Urban Cattle Foraging Realities by Devi S Nair, An...Mansi Shah
This study examines cattle rearing in urban and rural settings, focusing on milk production and consumption. By exploring a case in Ahmedabad, it highlights the challenges and processes in dairy farming across different environments, emphasising the need for sustainable practices and the essential role of milk in daily consumption.
Expert Accessory Dwelling Unit (ADU) Drafting ServicesResDraft
Whether you’re looking to create a guest house, a rental unit, or a private retreat, our experienced team will design a space that complements your existing home and maximizes your investment. We provide personalized, comprehensive expert accessory dwelling unit (ADU)drafting solutions tailored to your needs, ensuring a seamless process from concept to completion.
EASY TUTORIAL OF HOW TO USE CAPCUT BY: FEBLESS HERNANEFebless Hernane
CapCut is an easy-to-use video editing app perfect for beginners. To start, download and open CapCut on your phone. Tap "New Project" and select the videos or photos you want to edit. You can trim clips by dragging the edges, add text by tapping "Text," and include music by selecting "Audio." Enhance your video with filters and effects from the "Effects" menu. When you're happy with your video, tap the export button to save and share it. CapCut makes video editing simple and fun for everyone!
Storytelling For The Web: Integrate Storytelling in your Design ProcessChiara Aliotta
In this slides I explain how I have used storytelling techniques to elevate websites and brands and create memorable user experiences. You can discover practical tips as I showcase the elements of good storytelling and its applied to some examples of diverse brands/projects..
1. Technical Writing
What is technical writing?
Technical writing is any writing designed to explain complex, technical, and
specialized information to audiences who may or may not be familiar with
them. It is typically used in technical and occupational fields like
engineering, robotics, computer hardware and software, medicine, finance,
and consumer electronics. In your professional life, sometimes you’ll need
to write formal business letters or different kinds of reports. You will also
learn that writing an email to a friend is not the same as writing in a job-
related context.
2. Technical Writing
Technical Writing is writing that is done for the purpose of
educating, informing, or directing someone on how to do
something.
Technical writing is different from other types of writing such as
narrative, because technical writing aims to teach /inform the
reader about specific skills or abilities.
Technical writing isn't for everyone. It is often very detail-oriented
and usually involves writing within fields where some advanced
knowledge is required. When you are given a technical writing
assignment, you must approach it in a certain way in order to be
successful.
3. Technical Writing
Before you start working on any form of technical writing, you need to know
about some important elements :
Content (information, advice, warning, reminding, asking questions…)
Context (Before/after a meeting, during a conference, after a project…)
English Language (grammar, spelling, punctuation, meaning…)
Genre (Letter/email, report, brochure, agenda of a conference,
specification…)
Writing process : The steps of writing.
4. Types of Technical Writing
■ Consumer-directed technical writing refers to technical content written for end-users or
consumers. Good examples include user manuals, employee handbooks, standard operating
procedures (SOP), software user documentation (help files), troubleshooting guides, and
legal disclaimers.
■ Expert-to-expert technical writing is written chiefly for a knowledgeable audience. It includes
scientific papers, medical case studies, annual business reports, and legal case reviews.
■ Technical marketing content is technical information presented in a digestible format to
promote a product or service. For example, marketing case studies, product brochures, press
releases, and business plans and proposals.
5. Technical Writing
6 Steps to Writing a Technical Piece That People Actually Want to Read
1. Identify Your Audience
Knowing your audience is super important, especially when writing technical content.
For example, the new dad learning to build his first crib may have a different level of medical
knowledge than the experienced doctor reading a medical research paper.
When you have a clear idea of who you expect to read your piece, you can adjust your
vocabulary, tone, and framing accordingly.
This allows you to meet your reader at their point of knowledge.
6. Technical Writing
6 Steps to Writing a Technical Piece That People Actually Want to Read
2. Dig Deep in Your Research
As a technical writer, you’ll be guiding your reader through entirely unfamiliar territory.
You might be explaining how a new electronic tool works, what to expect from their new workplace, or what
happened before their firm took on a new legal case. It is essential that you fully understand your
subject matter.
You can only teach what you know, and knowledge gaps show when you aren’t thorough in your research.
Place yourself in your readers’ shoes. Imagine you had zero knowledge of the topic at hand and ensure
your research covers all potential questions that come to mind.
7. Technical Writing
6 Steps to Writing a Technical Piece That People Actually Want to Read
3. Create an Outline
We recommend creating an outline to give you a sense of what you need to cover in your piece.
This can also help identify knowledge gaps as you conduct your research.
When you’re writing longer-form content like case studies, an outline can serve as a marker to
remind you of what you need to include.
Instead of an outline, you can use a template. Some technical writing, such as business
plans, have industry-accepted formats, including sections like an executive summary and
competitor analysis.
8. Technical Writing
6 Steps to Writing a Technical Piece That People Actually Want to Read
4. Focus on Readability
Technical writing is not creative writing—you're writing to teach, not inspire or entertain. When tackling complicated topics,
using readable sentences can make your work more enjoyable to read.
f you use words that are hard to understand, you’ll only frustrate your reader. If you want to improve readability in technical
content, try these tips:
■ Use simple language: Strive for shorter, direct sentences that are easy to follow, and avoid passive voice wherever
possible.
■ Use subheadings: For longer-form content like user documentation, white papers, and research papers, adding
subheadings can break up long text walls.
■ Add bolded sections: Bolding text and highlighting paragraphs or callouts for emphasis will make reading easier.
■ Hyperlinks and jump links: If you’re writing technical content for web pages, add hyperlinks to any material you
reference and jump links to other sections of your piece for easier navigation.
9. Technical Writing
6 Steps to Writing a Technical Piece That People Actually Want to Read
5. Add Visuals
■ We’re all about the words and the writing, but visuals can make your technical writing easier to
understand! In technical writing, adding visuals is less of a luxury and more of a necessity,
depending on the type of the subject. Visuals such as flowcharts, screenshots, and illustrations
can add a much-needed dose of cheer to text-heavy documents.
■ Whether you’re creating a user manual or annual report for stakeholders, everyone will be
happier with product drawings showing the directions or a pie chart displaying the numbers.
10. Technical Writing
6 Steps to Writing a Technical Piece That People Actually Want to Read
6. Cut the Fluff
■ When you’ve got all the words on paper, it’s time to double-check the facts with collaborators.
Don’t be afraid to cut unnecessary information during this writing phase.
■ How do you identify the fluff? Removing fluff doesn’t impact the readers’ understanding of your text. It
could be a word, a sentence, a paragraph, or a step in the directions. Every word in your technical
document should count.