BSc CSIT (TU) Science Technical Writing (BSc CSIT, CSC368) Question Paper 2081 Nepal

Principles of Effective Technical Communication

Technical communication conveys complex, factual information to a defined audience so that they can understand, act on, or make decisions from it. Its effectiveness rests on four core principles: clarity, conciseness, accuracy and coherence.

1. Clarity

Clarity means the message is easily and unambiguously understood by the reader on the first reading.

• Use simple, precise words and short sentences; prefer the active voice.
• Avoid vague terms, unnecessary jargon and ambiguous pronouns.
• Use headings, lists, figures and examples to make ideas visible.

Unclear: "The thing was processed." Clear: "The server validated the login request."

2. Conciseness

Conciseness means saying everything necessary in as few words as possible without losing meaning.

• Eliminate redundancy, filler phrases and wordiness (e.g., "due to the fact that" -> "because").
• Remove information the audience does not need.
• Concise documents save the reader's time and reduce misreading.

3. Accuracy

Accuracy means the information is correct, factual and verifiable.

• Check data, figures, references, units and technical details.
• Distinguish facts from opinions; cite sources.
• A single inaccurate value (a wrong measurement or instruction) can cause failure or harm, so technical writing demands rigorous proofreading.

4. Coherence

Coherence means the document is logically organized and flows smoothly so ideas connect.

• Arrange content in a sensible sequence (chronological, general-to-specific, problem-solution).
• Use transitions, parallel structure and consistent terminology.
• Each paragraph should follow naturally from the previous one toward a unified purpose.

Conclusion

When a document is clear, concise, accurate and coherent, the reader understands the intended message quickly, trusts the information, and can act correctly. Together these principles—supported by completeness, correctness and consideration of the audience—make technical communication effective.

Types of Business Correspondence

Business correspondence is the exchange of written information between an organization and its internal or external parties for official purposes. The main types are:

1. Internal correspondence – communication within an organization (e.g., memos, notices, internal emails).
2. External correspondence – communication with outside parties such as customers, suppliers and government (e.g., business letters, enquiry/quotation/order/complaint letters).
3. Personal/Employment correspondence – job applications, cover letters, appointment and resignation letters.
4. Circular/Sales correspondence – messages sent to many recipients, e.g., sales letters, circulars and newsletters.
5. Electronic correspondence – email, instant messaging and other digital messages.

Structure of a Business Letter

A formal business letter (full-block or modified-block) typically contains:

• Letterhead / Sender's address and date
• Inside (receiver's) address
• Salutation (e.g., Dear Sir/Madam,)
• Subject line
• Body – introduction, main message, and closing/action paragraphs
• Complimentary close (e.g., Yours faithfully,)
• Signature, name and designation
• Enclosures / CC (if any)

Structure of a Memo (Memorandum)

A memo is an internal message with a simple, headed format:

TO:      [recipient]
FROM:    [sender]
DATE:    [date]
SUBJECT: [topic]
----------------------------------
Body: opening (purpose), discussion (details),
closing (action required).

Memos have no salutation or complimentary close; they are brief and direct.

Structure of an Email

An email combines the brevity of a memo with electronic headers:

• To / Cc / Bcc fields
• Subject line (clear and specific)
• Greeting (e.g., Dear Mr. Sharma, or Hi team,)
• Body – concise paragraphs stating purpose and action
• Sign-off (e.g., Regards,) and signature block (name, title, contact)
• Attachments if needed

Conclusion

Letters are formal external documents, memos serve quick internal communication, and emails offer fast, flexible electronic correspondence. Choosing the right form and following its standard structure ensures clear, professional business communication.

Technical Writing

Definition

Technical writing is a form of writing that conveys complex, specialized or technical information clearly, accurately and objectively to a specific audience so that they can understand a subject or perform a task. Examples include user manuals, technical reports, proposals, specifications, online help and instructions.

Characteristics of Technical Writing

1. Audience-centred – written for a defined reader (users, engineers, managers) with their knowledge level in mind.
2. Purpose-driven – aims to inform, instruct or persuade for a practical goal.
3. Clarity and precision – uses exact, unambiguous language.
4. Conciseness – delivers information in as few words as necessary.
5. Accuracy – facts, data and instructions must be correct and verifiable.
6. Objectivity – impersonal, fact-based tone, free of personal feelings.
7. Logical organization – structured with headings, lists and a clear sequence.
8. Use of visuals – tables, diagrams, charts and graphs support the text.
9. Standard format – follows conventions (reports, manuals, memos).

How It Differs from Other Forms of Writing

Examples

• Technical writing: "Press the Reset button for 5 seconds to restore factory settings." – direct instruction, exact value.
• Creative writing: "The old machine sighed and surrendered, its lights fading like a tired sunset." – imagery and emotion.

Conclusion

Technical writing is purposeful, accurate and audience-focused, designed to help readers understand or do something. Unlike creative writing, which prizes imagination and style, technical writing values clarity, correctness and usefulness above all.

Technical Writing vs. Creative Writing

In short: Technical writing prioritizes accuracy, clarity and usefulness for a practical purpose, while creative writing prioritizes imagination, style and emotional impact.

News Release

What is a News Release?

A news release (or press release) is a short, official written statement issued by an organization to the news media to announce something newsworthy—such as a new product, event, achievement, appointment or policy. Its goal is to gain media coverage by giving journalists ready, factual information written in news style.

Structure of a News Release

1. Letterhead / Logo – identifies the issuing organization.
2. Release line – "FOR IMMEDIATE RELEASE" or a release date/time.
3. Headline – a concise, attention-grabbing title summarizing the news.
4. Dateline – the place and date of the release (e.g., KATHMANDU, June 4 —).
5. Lead (opening paragraph) – answers the 5 Ws and H (who, what, when, where, why, how) in the first sentence; the most important information comes first (inverted-pyramid style).
6. Body – supporting details, facts, background and quotations from officials, arranged in decreasing order of importance.
7. Boilerplate – a short standard paragraph describing the organization ("About...").
8. Contact information – name, phone and email of the media contact.
9. End mark – "###" or "-END-" to signal the close.

Conclusion

Following the inverted-pyramid structure—headline, dateline, lead, body, boilerplate and contact—lets editors quickly grasp and publish the story, making the news release an effective public-relations tool.

The Seven Cs of Effective Communication

The Seven Cs are guidelines that make any business or technical message effective:

1. Clarity – The message expresses one idea at a time in simple, unambiguous language so the receiver understands it easily.
2. Conciseness – Convey the message in the fewest possible words; remove wordiness and redundancy while keeping completeness.
3. Concreteness – Be specific and definite; use facts, figures and concrete details rather than vague statements.
4. Correctness – Ensure correct grammar, spelling, punctuation, facts and figures; use the right level of language for the audience.
5. Completeness – Include all the information the receiver needs to understand and act (answer the 5 Ws where relevant).
6. Consideration – Adopt the "you-attitude"; address the receiver's needs, interests and viewpoint with empathy.
7. Courtesy – Be polite, respectful, sincere and positive in tone, building goodwill.

Conclusion: When a message is clear, concise, concrete, correct, complete, considerate and courteous, it is well received and achieves its purpose effectively.

Informative Brief

What is an Informative Brief?

An informative brief is a short, factual document that gives the reader a clear summary of information on a topic, situation or task without persuasion. Its purpose is simply to inform—to update, explain or provide background so the reader is well informed and can make decisions or take action. It is concise, objective and arranged logically, often with headings or bullet points.

Key Features

• States purpose and key facts up front.
• Objective and neutral in tone (no opinion or argument).
• Brief and well-structured (background, key points, conclusion/next steps).

Example

Subject: Brief on Library Wi-Fi Upgrade

Background: The college library Wi-Fi currently supports 50 simultaneous users and is frequently overloaded during exams.

Key Points:

• The IT department has proposed upgrading to a system supporting 200 users.
• Estimated cost: NPR 4,00,000; installation time: 2 weeks.
• No service disruption is expected during off-peak installation.

Conclusion: The upgrade will resolve current congestion. Approval is requested to proceed by the end of this month.

This brief informs the reader of the situation and facts so a decision can be made, without arguing for a particular emotional response.

Formal vs. Informal Reports

Summary: A formal report is long, structured and impersonal for important or external use, whereas an informal report is short, simple and conversational for routine internal communication.

Memorandum (Memo)

What is a Memorandum?

A memorandum (memo) is a short, written message used for internal communication within an organization. It is used to convey information, give instructions, request action, or record decisions among employees and departments. Memos are brief, direct and informal compared with letters, and they have no salutation or complimentary close.

Format of a Memorandum

A standard memo has two parts: a heading and a body.

1. Heading block:

MEMORANDUM
TO:      [Name / designation of recipient]
FROM:    [Name / designation of sender]
DATE:    [Date]
SUBJECT: [Brief topic of the memo]

(Optional: CC, REF/Memo number)

2. Body (three parts):

• Opening / Purpose – states why the memo is written.
• Discussion / Details – gives the necessary facts, explanation or background.
• Closing / Action – states the action required, request or conclusion.

Sometimes the sender's initials are placed beside the FROM line, and attachments are noted at the end.

Example

MEMORANDUM
TO:      All Staff
FROM:    R. Sharma, Office Manager
DATE:    4 June 2026
SUBJECT: Office Closure for Maintenance

The office will remain closed on Saturday for electrical
maintenance. Please save your work and shut down computers
before leaving on Friday. Normal operations resume Monday.

Conclusion: A memo's simple TO/FROM/DATE/SUBJECT heading and a short purpose-discussion-action body make it an efficient tool for quick internal communication.

Importance of Revising and Editing in Technical Writing

Revising and editing are the final, essential stages of the writing process that turn a rough draft into a clear, correct and professional document.

Revising

Revising focuses on the content and structure (the big picture):

• Checks whether the document is complete, accurate and logically organized.
• Ensures the content suits the audience and purpose.
• Improves clarity, coherence and flow; reorders or removes weak material.

Editing

Editing focuses on the language and surface details:

• Corrects grammar, spelling, punctuation and word choice.
• Ensures consistency in style, terminology, formatting and visuals.
• Polishes sentences for conciseness and readability.

Why They Are Important

1. Accuracy – removes factual errors, wrong data and inconsistencies that could cause failure or harm.
2. Clarity – ensures the reader understands the message without confusion.
3. Credibility – an error-free document builds the writer's and organization's reputation.
4. Conciseness – trims wordiness and redundancy.
5. Professionalism – a polished document looks reliable and trustworthy.
6. Audience suitability – confirms the document meets the reader's needs.

Conclusion: Without careful revising and editing, even good information can mislead readers. These steps guarantee that technical documents are clear, accurate, consistent and professional.

Abstract

What is an Abstract?

An abstract is a brief, self-contained summary of a longer document (such as a report, research paper or proposal) that states its main purpose, scope, methods, results and conclusions. It allows readers to quickly judge whether the full document is relevant to them. An abstract is usually one paragraph (typically 100–250 words) placed at the beginning of the document.

Descriptive vs. Informative Abstracts

In short: A descriptive abstract tells the reader what the report covers, while an informative abstract tells the reader what the report actually found and concluded.

Jargon in Technical Writing

What is Jargon?

Jargon is the specialized vocabulary or technical terminology used by a particular profession, trade or group (e.g., bandwidth, API, latency in computing; dividend, liquidity in finance). These terms have precise meanings understood by experts in the field but may be confusing to outsiders.

Its Use in Technical Writing

• When the audience is expert: Jargon is appropriate and even desirable because it is precise, efficient and unambiguous—one technical term replaces a long explanation and shows shared professional understanding.
• When the audience is non-expert: Jargon should be avoided or explained, since it reduces clarity and can confuse readers. The writer should define the term on first use or replace it with a plain-language equivalent.

Guidelines

1. Know your audience – use jargon only if readers will understand it.
2. Define unfamiliar terms – include a glossary or parenthetical explanation.
3. Avoid unnecessary jargon – do not use technical words merely to sound impressive.
4. Be consistent – use the same term for the same concept throughout.

Conclusion: Jargon is a useful tool for precise communication among specialists, but in audience-centred technical writing it must be used carefully—appropriate for experts, but defined or avoided for general readers to preserve clarity.