17. LEARNING OUTCOMES
At the end of this lesson, I can:
Identify the key activities and considerations in each stage
of the technical writing process.
Utilize the gathered information to create well-structured
and coherent technical documents.
Recognize the benefits of adopting a process approach
to technical writing.
18. IT IS DIVIDED INTO THREE STAGES:
The process of technical writing is both
technical and creative.
19. Before beginning to write, you should invest some time
planning what to write and how to transmit the information.
In order to do this, you should consider:
Audience and purpose
Tone and style
Gathering of information
Outlining
PRE-WRITING STAGE
20. Drafting is the actual writing process.
At this stage, it is important to consider the main parts of
the text, paragraph development and coherence as well
as genre conventions.
DRAFTING OR WRITING STAGE
21. Major aspects of writing:
Language Appropriateness
Conciseness and Flow
Maintenance of Impersonal and Formal Language
Bias Free Language
Maintenance of Style
Adaptability
Clarity
Word economy
Sentence Variety
DRAFTING OR WRITING STAGE
22. Revising is considered as the third stage in the writing
process.
There is a mythical belief that echoes in the mind of some
writer: “I am the author and creator who never fails! And I need
no editing”. This is a mere belief and not accepted and
practised in the writing profession.
POST-WRITING OR EDITING STAGE
23. The final stage of the writing process involves:
Revising Content and Organization
Checking for Grammatical Accuracy
Editing for Style
Proofreading and Peer Review
POST-WRITING OR EDITING STAGE
25. THE TECHNICAL WRITING
PROCESS
‘If you fail to plan, you plan to fail.’ All projects
need to be planned – at least at some level.
STEP 1 - PLAN
26. THE TECHNICAL WRITING
PROCESS
To be considered when planning:
• Scope
• Timing
• Process
• Audience
• Reviewers/Subject Matter Experts
• Existing information
• Style guide / templates
STEP 1 - PLAN
27. THE TECHNICAL WRITING
PROCESS
A structure is the backbone of your document –
the hierarchy of headings that define the logical order
that it will progress.
STEP 2 - STRUCTURE
28. THE TECHNICAL WRITING
PROCESS
• Narrative structure – The traditional approach – introduction,
body, conclusion.
• Process-based structure – Common in technical
documentation such as procedures and user guides.
• Library structure – A collection of articles on a common topic,
loosely structured.
• System-based structure – Describing the components of
a system such as an auto manual.
STEP 2 - STRUCTURE
29. THE TECHNICAL WRITING
PROCESS
Writing is where you convert your bare-bones table of
contents and notes into a series of drafts, culminating in a draft
that’s ready for formal review.
STEP 3 - WRITE
30. THE TECHNICAL WRITING
PROCESS
There are a few time-honoured (as well as some new) techniques
that technical writers draw on:
• KISS (Keep It Simple, Stupid!)
• Plain English
• Five Ws (and One H)
• Inverted pyramid
• Verb-noun structure
• Active voice
STEP 3 - WRITE
31. THE TECHNICAL WRITING
PROCESS
Think of review as the polishing stage. It’s where your
document gets the trial by fire, so to speak, of having others
formally review it, as well as undergoing another very
important task – editing and proofing.
STEP 4 - REVIEW
32. THE TECHNICAL WRITING
PROCESS
In the Review step, there are a number of discrete activities going
on:
• Review by subject matter experts
• Testing a procedure / instruction to make sure you / a subject
matter expert can follow the steps
• Peer review by a colleague
• Editing and proofing
STEP 4 - REVIEW
33. THE TECHNICAL WRITING
PROCESS
Publishing can be a complicated process – or it can be
extremely easy. Publication is where writers manufacture and
launch the final product. This might be as straightforward as
emailing an approved document to your manager, or uploading
it to a content management system or intranet.
STEP 5 - PUBLISH
34.
35. THE TECHNICAL WRITING
PROCESS
Some of the benefits that can be obtained from adopting this
process approach are outlined below:
It helps the writer overcome the blank page syndrome and
therefore get started.
It serves the writer as a guide to writing since it suggests possible
steps to follow in the writing process.
It makes the writer aware of contextual considerations such as
audience and purpose.
It promotes awareness of the writing process.
It accounts for individual variation, that is, it encompasses different
learning styles and preferences.
36. REFERENCE:
• Basics of Technical Writing: Process, A Beginner's
Guide (getuplearn.com)
• The Technical Writing Process | Technical Writing
Process
38. MULTIPLE CHOICE: Read the questions carefully.
Choose and write the correct answer.
1. Which stage of the technical writing process involves
brainstorming and analyzing sources of information?
A. Pre-Writing Stage B. Review and Revision
C. Drafting/Writing Stage D. Post Writing/Editing Stage
2. Which aspect of writing focuses on using appropriate language
for the target audience?
A.Bias-Free Language
B. Conciseness and Flow
C. Language Appropriateness
D. Maintenance of Impersonal and Formal Language
39. 3. Which stage of the technical writing process involves revising content
and organization?
A. Pre-Writing Stage B. Drafting/Writing Stage
C. Post Writing/Editing Stage D. Peer Review and Proofreading
4. Which step of the technical writing process involves planning the scope,
timing, and audience of the document?
A. STEP 1 PLAN B. STEP 3 WRITE
C. STEP 4 REVIEW D. STEP 2 STRUCTURE
5. Which structure is commonly used in technical documentation such as
procedures and user guides?
A. Library structure B. Narrative structure
C. System-based structure D. Process-based structure
40. 6. Which technique focuses on answering the questions of who,
what, when, where, why, and how in technical writing?
A. Plain English B. Verb-noun structure
C. Five Ws (and One H) D. KISS (Keep It Simple, Stupid!)
7. Which stage of the technical writing process involves editing and
proofreading?
A. Pre Writing Stage B. Drafting or Writing Stage
C. Post Writing/Editing Stage D. Peer Review and Proofreading
8. Which step of the technical writing process involves converting the
table of contents and notes into a series of drafts?
A. STEP 1 PLAN B. STEP 3 WRITE
C. STEP 4 REVIEW D. STEP 2 STRUCTURE
41. 9. Which activity in the Review step involves having others
formally review the document?
A. Editing and proofreading
B. Peer review by a colleague
C. Testing a procedure/instruction
D. Review by subject matter experts
10. Which stage of the technical writing process involves
manufacturing and launching the final product?
A. STEP 1 PLAN
B. STEP 3 WRITE
C. STEP 4 PUBLISH
D. STEP 2 STRUCTURE
42. 11. Which benefit does the process approach to technical writing
provide?
A. Serving as a guide to writing
B. Overcoming the blank page syndrome
C. Promoting awareness of the writing process
D. All of the above
12. Which structure describes the components of a system, such as an
auto manual?
A. Library structure B. Narrative structure
C. System-based structure D. Process-based structure
13. Which structure is the traditional approach (introduction, body,
conclusion)?
A. Library structure B. Narrative structure
C. System-based structure D. Process-based structure
43. 14. Which technique focuses on using language that is
clear, concise, and free from unnecessary jargon?
A. Active Voice
B. Plain English
C. Five Ws (and One H)
D. KISS (Keep It Simple, Stupid!)
15. These are the things to be considered in the Pre-Writing
stage, except:
A. Outlining
B. Editing for style
C. Audience and purpose
D. Gathering of information
The pre-writing stage is the initial phase of technical writing, where you plan and prepare before starting to write.
Before writing, you need to identify your target audience and understand their needs, knowledge level, and expectations. This helps you tailor your writing style and content to effectively communicate with them. Additionally, you should determine the purpose of your writing, whether it is to inform, persuade, or instruct.
Choosing an appropriate tone and style is crucial in technical writing. The tone refers to the attitude or emotion conveyed in your writing, while the style refers to the overall writing approach or voice. The tone and style should align with the audience and purpose of your document. (If you're writing a research paper for a scientific journal, the tone should be formal and objective. Avoid using personal anecdotes or informal language. Instead, focus on presenting factual information and supporting evidence.
This involves researching and collecting relevant information for your document. You may brainstorm ideas, analyze various sources such as books, articles, or databases, and conduct interviews or surveys to gather data. This stage ensures that you have accurate and up-to-date information to support your writing.
Organizing your thoughts and creating an outline helps you structure your document effectively. An outline provides a roadmap for your writing, allowing you to arrange information logically and coherently. It helps you identify the main sections, subtopics, and their order, ensuring a clear and organized flow of ideas. (For a business proposal, your outline might include sections such as Introduction, Problem Statement, Proposed Solution, Budget, and Conclusion.)