Grammar, Clarity & Concise Writing

TAKEAWAYS:

• Grammar ensures correctness and professionalism in technical writing, avoiding errors that undermine credibility.
• Clarity is achieved through active voice, simple language, and logical structure to eliminate ambiguity.
• Conciseness removes redundancy, fluff, and unnecessary words to improve readability and efficiency.
• Revised writing undergoes multiple stages (editing, proofreading, peer review) to refine technical documents.
• Technical vs. personal writing differs in purpose, audience, and style—technical writing prioritizes precision and structure.
• Common pitfalls (passive voice, vague terms, wordiness) can be corrected using targeted techniques and tools.

Grammar in Technical Writing

Technical writing demands grammar mastery to convey information accurately and professionally. Errors—whether in syntax, punctuation, or word choice—distract readers and erode trust. Below are key grammar rules and their application in technical contexts.

1. Subject-Verb Agreement

The subject and verb must agree in number (singular/plural).

• Correct: The system requires an update.
• Incorrect: The system require an update.

Why it matters: In manuals or reports, mismatched verbs create confusion. For example, a software guide must clearly state:

"The API endpoint returns a JSON response." (not "returns" if the subject is singular).

2. Active vs. Passive Voice

• Active voice (subject performs the action) is preferred for clarity and directness.
  • We tested the prototype. (clear, direct)
• Passive voice (action is done to the subject) is used when the doer is unknown or irrelevant.
  • The prototype was tested by our team. (less direct, but useful in reports where the agent is obvious).

Worked Example: Original (passive, vague):

"The report was prepared by the team." Revised (active, concise): "The team prepared the report."

When to use passive voice:

• In technical specifications where the process matters more than the actor:

  "The data will be encrypted using AES-256." (focus on how, not who).

3. Parallel Structure

Items in a list or sentence must follow the same grammatical form.

• Correct: The system supports uploading, downloading, and sharing files.
• Incorrect: The system supports uploading, downloading, and to share files.

Why it matters: In instructions, parallelism ensures readability. For example:

*"To configure the device, follow these steps:

1. Connect the cable.
2. Power on the device.
3. Enter the settings menu."* (consistent verbs)

4. Punctuation Rules

• Commas: Separate clauses and items in lists.
  • Incorrect: "After installation the system will reboot." (missing comma)
  • Correct: "After installation, the system will reboot."
• Semicolons: Join complex clauses.
  • "The server crashed; we restarted it immediately."
• Colons: Introduce lists or explanations.
  • "Requirements: Java 11, Python 3.8, and a database."

Real-World Example: In eSewa’s transaction instructions, punctuation clarifies steps:

*"To pay via eSewa:

1. Open the app;
2. Select ‘Pay Bill’;
3. Enter merchant ID: 12345678."*

Clarity in Technical Writing

Clarity ensures readers understand instructions, reports, or documentation without confusion. Vague or ambiguous language leads to errors, delays, or safety risks.

sequenceDiagram participant User participant DarazApp participant DarazBackend
    User->>DarazApp: "How do I cancel an order after payment?"
    DarazApp->>User: "Follow these steps:
    1. Open the app
    2. Tap **My Orders**
    3. Select the order
    4. Click **Cancel Order**"
    User->>DarazApp: "I see **‘Cancel Order’** but it’s grayed out—why?"
    DarazApp->>DarazBackend: "Check order status"
    DarazBackend-->>DarazApp: "Status: **‘Processing’** (cannot cancel)"
    DarazApp->>User: "You can only cancel orders marked **‘Pending’** or **‘Cancelled’**."
    User->>DarazApp: "Got it. Where’s the refund policy?"
    DarazApp->>User: "See **FAQs > Refunds** or contact support at **support@daraz.com**"

A sequence diagram of a user’s interaction with Daraz’s app, illustrating clarity techniques: active voice (direct instructions), logical order (step-by-step), and definition of terms (e.g., ‘Processing’ vs. ‘Pending’ status). Shows how avoiding jargon (e.g., ‘cancelable state’) improves usability.

Techniques for Clarity

Common Vagueness Pitfalls

Worked Example: Original (vague):

"The software may have some problems after the update." Revised (clear): "Users may encounter a login failure (Error Code: 101) after the update. Resolve by clearing the cache."

Conciseness in Technical Writing

Conciseness removes unnecessary words, improving readability and efficiency. Technical documents—manuals, reports, emails—benefit from precision.

Techniques for Conciseness

1. Eliminate Redundancy
   • Incorrect: "We came to the conclusion that..."
   • Correct: "We concluded that..."
2. Replace Phrases with Words
   • Incorrect: "at the present time"
   • Correct: "now"
3. Avoid Fluff
   • Incorrect: "Due to the fact that..."
   • Correct: "Because..."
4. Use Strong Verbs
   • Weak: "The team is going to analyze the data."
   • Strong: "The team analyzes the data."

Before/After Examples

Real-World Example: Khalti’s Payment Instructions (original vs. revised):

• Original:

  "It is highly recommended that you ensure that your internet connection is stable before proceeding with the transaction."

• Revised:

  "Check your internet connection before paying."

Grammar, Clarity, and Conciseness in Action

1. Editing for Clarity and Conciseness

Task: Revise the following sentences (from past exams) without changing meaning. Original:

"It is difficult to establish a general area cost per square foot of installation for this system."

Revised:

"Calculating the cost per square foot varies by location."

Why?

• Removes passive construction ("is difficult to establish" → "varies").
• Simplifies phrasing ("general area cost" → "cost").
• More direct and concise.

2. Technical vs. Personal Writing

Why It Matters: In a bank’s loan application, technical writing ensures clarity:

*"Submit the following documents:

1. Passport-sized photo.
2. Proof of income (salary slips for the last 6 months).
3. Property deed (if applicable)."*

In contrast, a personal email might say:

"Hey, I’m thinking of visiting Kathmandu next week—any recommendations for places to eat?"

In the Real World

1. eSewa’s Transaction Guides

   • Idea Used: Clarity and conciseness.
   • How: eSewa’s app instructions avoid jargon and use bullet points for step-by-step guidance. For example:

     *"To pay your electricity bill:

     1. Open eSewa.
     2. Tap ‘Pay Bill’.
     3. Select ‘Electricity’ and enter your meter number."*

   • Why It Works: Users (often non-technical) complete transactions quickly without confusion.

2. Daraz’s Order Tracking

   • Idea Used: Conciseness and active voice.
   • How: Daraz’s tracking emails use short, direct language:

     "Your order #12345 is out for delivery (ETA: 10 AM). Track it here: [link]."

   • Why It Works: Eliminates fluff; users immediately see their order status.

3. NEPSE’s Market Updates

   • Idea Used: Grammar and clarity.
   • How: NEPSE’s reports avoid passive voice and use precise terms:

     "The NEPSE index rose by 0.5% today due to strong demand in banking stocks."

   • Why It Works: Investors rely on accurate, unambiguous data for decisions.

Exam Tip

This unit is highly practical and tests:

1. Grammar Correction: Expect sentences to edit for correctness (e.g., subject-verb agreement, punctuation).
2. Clarity vs. Vagueness: Compare vague vs. clear examples (e.g., "It is important" vs. "The deadline is Friday").
3. Conciseness: Rewrite wordy sentences (aim for 20–30% reduction in words).
4. Technical vs. Personal Writing: Differentiate styles with examples (focus on audience, purpose, and tone).
5. Revision Techniques: Briefly discuss stages like editing, peer review, and proofreading (1–2 sentences each).

Common Pitfalls to Avoid:

• Overusing passive voice (prefer active where possible).
• Including unnecessary details (e.g., "As you may know...").
• Ignoring parallel structure in lists or clauses.

Sample Question Breakdown:

• Grammar: "Correct the following: ‘The team was discussed the issue yesterday.’" → "The team discussed the issue yesterday."
• Clarity: "Rewrite: ‘There might be some problems with the login page.’" → "The login page may fail due to server errors."
• Conciseness: "Shorten: ‘It is necessary for you to submit the documents by the end of the week.’" → "Submit documents by Friday."

Pro Tip: Practice revising real-world documents (e.g., app instructions, emails) to internalize techniques. Use tools like Hemingway Editor (hemingwayapp.com) to check conciseness.