Writing Process & Revision Techniques

TAKEAWAYS:

• The writing process follows a cyclical model: planning, drafting, revising, and editing to refine technical content.
• Revision is critical in technical writing to eliminate ambiguity, improve structure, and enhance reader comprehension.
• Peer review and self-assessment checklists are key revision tools to catch errors and improve document quality.
• Clarity vs. vagueness is a core distinction—technical writing demands precision to avoid misinterpretation.
• Real-world applications include drafting loan agreements (banks), user manuals (Daraz), and technical reports (NEPSE).
• Tools like Grammarly, LaTeX, and Markdown streamline the writing and revision process for technical documents.

The Writing Process in Technical Writing

Technical writing is not a linear process but a cyclical, iterative one. Unlike creative writing, where inspiration drives the flow, technical writing requires a structured approach to ensure accuracy, clarity, and professionalism. The writing process typically consists of five key stages:

1. Planning
2. Drafting
3. Revising
4. Editing
5. Proofreading

Each stage serves a distinct purpose, and skipping any can lead to errors, ambiguity, or unprofessional output.

1. Planning: The Foundation of Technical Writing

Planning is the most critical stage—it sets the tone for the entire document. Without a clear plan, drafting becomes chaotic, and revisions may be extensive.

Key Steps in Planning:

• Identify the audience: Who will read this document? (e.g., engineers, customers, regulators)
• Define the purpose: Is it to inform, instruct, persuade, or explain?
• Gather information: Research facts, data, and references.
• Outline the structure: Use headings, subheadings, and bullet points to organize content logically.
• Set deadlines: Allocate time for each stage to avoid last-minute rushes.

Example: Writing a User Manual for Daraz Suppose you are writing a user manual for Daraz’s return policy. Your planning phase would include:

• Audience: First-time buyers, returning customers, Daraz support staff.
• Purpose: Clarify the return process, reduce customer complaints, and improve satisfaction.
• Structure:
  • Introduction (Why return?)
  • Step-by-step return process (with screenshots)
  • FAQs (e.g., "How long does processing take?")
  • Contact information for support.

Why Planning Matters:

• Saves time in the long run.
• Ensures the document is focused and relevant.
• Helps avoid scope creep (adding unnecessary details).

2. Drafting: Turning Plans into Words

Drafting is where the raw content is created. The goal is to get ideas down on paper without worrying too much about perfection.

Best Practices for Drafting:

• Write concise sentences—avoid jargon unless necessary.
• Use active voice (e.g., "The system updates records" instead of "Records are updated by the system").
• Include placeholders for images, tables, or references (e.g., "[Insert Figure 1]").
• Draft separately for different sections (e.g., introduction, procedures, conclusion).

Example: Drafting a Loan Agreement for a Bank A bank’s loan agreement for a home loan might start with:

Loan Agreement Between [Bank Name], represented by [Officer Name], and [Borrower Name], represented by [Borrower ID].

1. Loan Details

• Principal Amount: NPR 5,000,000
• Interest Rate: 8.5% per annum (compounded monthly)
• Loan Term: 20 years
• Repayment Schedule: Monthly installments

2. Conditions

• Borrower must maintain employment with a minimum salary of NPR 50,000/month.
• Late payments incur a penalty of 2% per month.

Common Drafting Mistakes:

• Overly complex sentences → "The system, which is designed to process transactions efficiently, may experience delays if the server is overloaded." Fix: "The system processes transactions efficiently but may delay if the server is overloaded."
• Vague language → "We will try our best to resolve the issue." Fix: "We will resolve the issue within 48 hours."

3. Revising: Refining for Clarity and Accuracy

Revision is not just correcting errors—it’s about improving structure, logic, and readability. Technical writing requires precision, so revising ensures the document is clear, concise, and error-free.

Key Revision Techniques:

Example: Revising a Technical Report for NEPSE Suppose you’re writing a market analysis report for NEPSE. Your initial draft might say:

"The stock market has been volatile recently." A revised version would be: "The NEPSE index experienced a 5% decline in the last quarter due to macroeconomic factors, including rising interest rates and geopolitical tensions."

Why Revision is Crucial:

• Avoids miscommunication (e.g., a vague loan term could lead to disputes).
• Improves professionalism (NEPSE reports must be precise).
• Reduces reader confusion (e.g., a Daraz user manual must be step-by-step clear).

4. Editing: Polishing the Document

Editing focuses on grammar, syntax, and formatting. It ensures the document is polished and professional.

Editing Checklist:

• Grammar and punctuation: Use tools like Grammarly or Hemingway Editor.
• Consistency: Dates (15th Jan 2024 or Jan 15, 2024?), abbreviations (e.g., "NPR" vs. "Nepalese Rupees").
• Formatting: Headings, bullet points, indentation, and font size.
• Spelling: Use spell-check but verify technical terms (e.g., "algorithm" vs. "algorithim").

Example: Editing an Email to a Client Before Editing:

Hey, I hope you are doing well. I am writing to inform you that the project is delayed due to some issues. We will update you soon. Best, [Your Name]

After Editing:

Dear [Client Name],

I hope this email finds you well. I am writing to inform you that the [Project Name] project has experienced a delay due to unforeseen technical challenges. We anticipate completing the revised timeline by [new deadline] and will provide a detailed update by [date].

Thank you for your patience.

Best regards, [Your Full Name] [Your Position] [Company Name]

5. Proofreading: The Final Check

Proofreading is the last line of defense against errors. It involves a final read-through to catch typos, formatting issues, and inconsistencies.

Proofreading Tips:

• Print the document and read it aloud (errors stand out more).
• Use color-coding (e.g., red for corrections, blue for additions).
• Have a second pair of eyes review it (e.g., a colleague or professor).

Example: Proofreading a Job Application Error in Draft:

Attached is my resume and cover letter for the position of Software Engineer at [Company]. Please review my qualifications and let me know if you require any further information. I am looking forward to hear from you soon.

Corrected Version:

Attached please find my resume and cover letter for the position of Software Engineer at [Company]. I would appreciate the opportunity to discuss how my skills in [List Skills] align with your requirements. Please let me know if you need any additional information. I look forward to your response.

Clarity vs. Vagueness in Technical Writing

One of the most critical distinctions in technical writing is between clarity and vagueness. Vague writing leads to misunderstandings, legal disputes, or operational errors.

classDiagram
    class VagueLanguage {
      + "We will try our best" 
      + "It might work"
      + "The issue is complex"
    }
    class ClearLanguage {
      + "We will resolve the issue by EOD tomorrow (May 21, 2024)"
      + "The system fails when memory exceeds 8GB"
      + "Follow these 5 steps to reset the password"
    }
    VagueLanguage --|> ClearLanguage : Avoid
    note for VagueLanguage "Leads to confusion, disputes, or delays"
    note for ClearLanguage "Ensures compliance, reduces errors, and builds trust (e.g., NEPSE reports, bank loan terms)"

Worked Example: Kathmandu Traffic Routes Suppose you’re writing traffic instructions for a new flyover in Kathmandu. A vague version:

"Take the next exit to avoid traffic."

A clear version:

"After passing the Mahaboudha Stupa, take the right exit onto Tribhuvan Marg. The flyover will merge with Kirtipur Road for a smoother route to the airport."

Why Clarity Matters:

• Saves time (e.g., a user doesn’t waste minutes trying to find a button).
• Reduces errors (e.g., a bank loan is paid correctly).
• Builds trust (e.g., NEPSE investors rely on precise reports).

In the Real World

Technical writing is everywhere—from the apps we use daily to the policies that govern our transactions. Here’s how the writing process and revision techniques are applied in real-world scenarios:

1. eSewa / Khalti: Transaction Confirmations

   • Idea Used: Clarity in drafting and revised error messages.
   • How?
     • When you transfer money via eSewa, the confirmation message is short, direct, and error-free (e.g., "NPR 1,000 transferred to [Account] successfully.").
     • If there’s a delay, the system revises the message to: "Transaction pending. Please check your internet connection and try again."
   • Revision Technique: A/B testing of messages to see which is clearer.

2. Pathao: Ride-Sharing Instructions

   • Idea Used: Structured drafting and peer review for safety.
   • How?
     • Pathao’s driver app has step-by-step instructions for picking up passengers, handling payments, and navigating routes.
     • These instructions are revised regularly based on driver feedback and accident reports to improve clarity.
   • Worked Example:
     • Vague Draft: "Follow the route to the destination."
     • Revised Version: "Turn right at the traffic light, then follow the signs for [Destination]. Avoid the construction zone on the left."

3. NEPSE: Market Reports

   • Idea Used: Data-driven drafting and expert revision.
   • How?
     • NEPSE’s daily market reports are written by economists and analysts who plan, draft, and revise based on real-time stock data.
     • Clarity is critical—a misworded sentence could lead to investor panic or misplaced confidence.
   • Example:
     • Draft: "The market is doing okay."
     • Revised: "The NEPSE index rose by 1.2% today, driven by gains in [Sector], despite a 0.5% decline in [Sector]."

Advantages and Disadvantages of the Writing Process

While the writing process is essential, it also has its challenges.

Exam Tip: How to Score Full Marks

This unit is highly examinable—expect short notes, comparisons, and application-based questions. Here’s how to maximize your score:

1. Understand the Stages

   • Know the 5 stages of writing (plan, draft, revise, edit, proofread) and their purpose.
   • Example answer:

     "The writing process in technical writing consists of planning (defining audience and purpose), drafting (creating raw content), revising (improving clarity), editing (polishing grammar), and proofreading (final error check). Each stage ensures the document is accurate, professional, and reader-friendly."

2. Compare Clarity vs. Vagueness

   • Use real examples from banks, NEPSE, or eSewa to show the difference.
   • Example answer:

     "Clarity in technical writing uses specific language (e.g., 'The system will reboot in 30 seconds'), while vagueness relies on general terms (e.g., 'The system will restart soon'). Vagueness risks misunderstanding, whereas clarity ensures efficiency (e.g., a user manual for NTC’s router)."

3. Discuss Revision Techniques

   • Mention self-assessment, peer review, and checklists as key revision tools.
   • Example answer:

     "Revision in technical writing involves self-assessment (reading aloud), peer review (colleague feedback), and checklists (grammar, consistency). For example, a loan agreement for a bank must be revised to ensure legal precision, while a Daraz user manual requires step-by-step clarity."

4. Apply to Real Scenarios

   • Link concepts to Nepali companies (e.g., Ncell’s network troubleshooting guide, Pathao’s driver instructions).
   • Example answer:

     "In Ncell’s network troubleshooting guide, the writing process ensures clear instructions for users. The planning stage defines the audience (tech-savvy vs. basic users), the drafting stage writes step-by-step fixes, and revision polishes the language to avoid confusion."

5. Use Checklists in Answers

   • If asked about revision stages, structure your answer like this:
     1. Content Review (Is the information accurate?)
     2. Structure Review (Are headings logical?)
     3. Clarity Review (Are sentences concise?)
     4. Formatting Review (Is the document professional?)

6. Avoid Common Mistakes

   • ❌ Don’t just list stages—explain why each is important.
   • ❌ Don’t ignore real-world examples—examiners love Nepali case studies.
   • ❌ Don’t confuse editing and proofreading—editing is about content, proofreading is about errors.

Final Tip: Practice writing a short technical document (e.g., a user manual for a mobile app or a loan agreement) and revise it using the stages discussed. This hands-on approach will reinforce your understanding and help you score well in exams.