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

Definition of Technical Writing

Technical writing is a form of writing that communicates complex, specialized, or technical information clearly, accurately and concisely to a specific audience so that they can perform a task, understand a process, or make a decision. It is used in user manuals, reports, proposals, specifications, online help and scientific documents.

Characteristics of Technical Writing

1. Accuracy — Facts, figures and instructions must be correct and verifiable.
2. Clarity — Ideas are expressed in plain, unambiguous language so readers interpret them in only one way.
3. Conciseness — Says only what is necessary; avoids padding and redundancy.
4. Audience-centred — Tailored to the reader's knowledge level and purpose.
5. Objectivity — Impersonal, fact-based and free of emotion or bias.
6. Structured and accessible — Uses headings, lists, tables, figures and white space for easy navigation.
7. Purpose-driven — Helps the reader do or understand something specific.

How It Differs from Other Forms of Writing

Examples:

• Technical writing: "Press the Power button for 3 seconds to switch off the device." — gives an exact instruction.
• Creative writing: "The old device sighed into silence as the screen faded to black." — evokes mood and imagery.

Thus, while a poem or short story aims to move the reader, a technical document aims to enable the reader to act or understand correctly.

What is Audience Analysis?

Audience analysis is the systematic process of identifying and studying the intended readers of a technical document — their knowledge, needs, expectations, attitudes and reading conditions — so that the document can be written in a way that best serves them. The central question is: Who will read this and why?

Importance of Audience Analysis

1. Appropriate content & detail — Determines how much background and explanation to include (an expert needs less than a novice).
2. Right vocabulary & tone — Decides whether technical jargon is acceptable or must be simplified.
3. Effective organization & format — Guides choice of structure, visuals and medium.
4. Achieves purpose — Ensures the reader can understand and act, making the document successful.
5. Saves time and cost — Avoids rework caused by mismatched documents.
6. Builds credibility — A well-targeted document earns the reader's trust.

Types of Audience

• Primary audience — those who act on the document (e.g., the operator).
• Secondary audience — those who are affected or who pass it on (e.g., managers).
• Experts, technicians, managers (executives), and lay/general readers — each needs a different approach.

Process of Analyzing the Audience

1. Identify the readers — Determine who they are and classify them (primary/secondary, expert/lay).
2. Assess their knowledge level — How familiar are they with the subject and terminology?
3. Determine their needs and purpose — What do they want to do with the document (learn, decide, perform a task)?
4. Consider their attitude and expectations — Are they receptive, sceptical, busy?
5. Examine the context of use — Where, when and how will they read it (office, field, screen, print)?
6. Account for cultural and demographic factors — Language, region, education.
7. Adapt the document — Based on the above, choose content depth, vocabulary, tone, organization, and visuals.

By completing this analysis before writing, the writer produces a document that is clear, relevant and usable for its actual readers.

Structure of a Formal Technical Report

A formal technical report is divided into three main parts: Front Matter, Body, and Back Matter. This standard structure helps readers locate information quickly and lends the report credibility.

1. Front Matter (preliminary pages)

These elements precede the main text and are usually numbered with small Roman numerals (i, ii, iii):

• Cover / Title page — Report title, author(s), organization, date, report number.
• Letter of transmittal — A short cover letter handing the report to the recipient.
• Abstract / Executive summary — A condensed overview of purpose, methods, results and recommendations.
• Table of contents — Lists sections with page numbers.
• List of figures and tables — Indexes all visuals.
• Acknowledgements and List of abbreviations/symbols (if needed).

2. Body (main text)

The core of the report, numbered with Arabic numerals (1, 2, 3):

• Introduction — States the purpose, scope, background and problem.
• Methodology / Procedure — Explains how the work was carried out.
• Results / Findings — Presents the data, often with tables and figures.
• Discussion / Analysis — Interprets the results and their significance.
• Conclusions — Summarizes what the findings mean.
• Recommendations — Suggests actions to be taken.

3. Back Matter (supplementary pages)

Material that supports but is not essential to the main argument:

• References / Bibliography — Sources cited.
• Appendices — Detailed data, calculations, code, raw tables, questionnaires.
• Glossary — Definitions of technical terms.
• Index — Alphabetical guide to topics (in long reports).

Together these three divisions ensure the report is complete, professional, easy to navigate and credible.

Technical Writing vs Creative Writing

In short: technical writing aims to make the reader understand or do something accurately, whereas creative writing aims to make the reader feel something or be entertained.

News Release

A news (press) release is a short, official written statement issued by an organization to the media (newspapers, TV, radio, online) to announce something newsworthy — such as a product launch, event, appointment, or achievement — in the hope that it will be published as news.

Structure of a News Release

1. Letterhead / Source — Organization name, logo and contact details at the top.
2. Release date / instruction — e.g., "FOR IMMEDIATE RELEASE" or an embargo date.
3. Headline — A short, catchy title summarizing the news.
4. Dateline — Place and date of issue (e.g., Kathmandu, June 4, 2026 —).
5. Lead (opening) paragraph — Answers the 5 Ws and 1 H (Who, What, When, Where, Why, How) — the most important information first (inverted-pyramid style).
6. Body paragraphs — Supporting details, quotations and background, in decreasing order of importance.
7. Boilerplate — A short standard paragraph describing the organization.
8. Contact information — Name, phone and email of the media contact.
9. End mark — "###" or "-END-" to signal the close.

The inverted-pyramid format ensures the key facts appear first so editors can cut from the bottom without losing essential information.

The Seven C's of Effective Communication

The Seven C's are principles that make any message clear and effective:

1. Clarity — The message should convey one clear idea, using simple, exact words so the receiver understands it easily.
2. Conciseness — Say it in as few words as necessary; remove wordiness and repetition while keeping all needed information.
3. Concreteness — Use specific facts, figures and details rather than vague statements.
4. Correctness — Ensure correct grammar, spelling, punctuation, and accurate facts and figures.
5. Completeness — Include all information the receiver needs to respond or act (answer all questions).
6. Consideration — Adopt the you-attitude; consider the receiver's viewpoint, needs and feelings.
7. Courtesy — Be polite, respectful, sincere and tactful in tone.

Applying these seven principles produces messages that are understood correctly, quickly and positively by the audience.

Informative Brief

An informative brief is a short, factual document that gives the reader concise, organized information about a topic, situation, project or issue so that they are well informed and can take a decision or action. Unlike a persuasive brief, its aim is purely to inform, not to argue — it presents facts objectively without trying to convince the reader of an opinion.

Key Features

• Brief and to the point.
• Objective and fact-based.
• Clearly structured (purpose, background, key facts/findings, conclusion).
• Written for a specific reader, often a busy decision-maker.

Example

A project manager prepares a one-page brief for the management team:

Subject: Status of Library Management System Project

Purpose: To inform management of current project progress.

Background: Development began on 1 January 2026 with a 6-month timeline.

Key facts: Modules completed — 70%. Testing of the catalogue module is in progress. Budget used: NPR 5,00,000 of 7,00,000.

Conclusion: The project is on schedule and expected to finish by 30 June 2026.

This brief simply informs the readers of the project status without persuading them toward any decision.

Formal vs Informal Reports

In short: a formal report is a long, structured and impersonal document for important or external purposes, whereas an informal report is a short, simply formatted and personal document for routine internal communication.

Memorandum

A memorandum (memo) is a short, informal written message used for communication within an organization. It is used to convey information, give instructions, make announcements, request action, or record decisions among employees, departments or management. Memos are concise, direct and do not use the salutation and complimentary close of a formal letter.

Format of a Memorandum

A memo has two parts — a heading segment and a body.

Heading segment (four standard lines):

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

Body segment:

• Opening — States the purpose of the memo directly.
• Discussion — Gives the details, facts or instructions needed.
• Closing — States the required action or a courteous closing line.

Sometimes the sender's initials are placed beside the FROM line instead of a full signature. The memo's strengths are its brevity, speed and direct, no-frills format.

Importance of Revising and Editing in Technical Writing

Revising means re-seeing the whole document to improve its content, organization and clarity, while editing means correcting the surface details such as grammar, spelling, punctuation, style and format. Both are essential final stages of the writing process.

Why They Are Important

1. Ensures accuracy — Catches factual errors, wrong figures and faulty instructions that could mislead the reader or cause harm.
2. Improves clarity — Removes ambiguity, awkward sentences and confusing structure so the message is understood in one way.
3. Achieves conciseness — Cuts wordiness, repetition and irrelevant material.
4. Corrects errors — Fixes grammar, spelling, punctuation and formatting mistakes that damage credibility.
5. Strengthens organization — Reorders ideas logically and ensures consistency in headings, terms and style.
6. Builds professionalism and credibility — An error-free, polished document earns the reader's trust.
7. Confirms the document meets its purpose and audience — Verifies the content truly serves the intended readers.

Without careful revising and editing, even technically correct content can fail because of poor clarity or careless errors; these stages turn a rough draft into a usable, professional document.

Abstract

An abstract is a brief, self-contained summary of a longer document (report, research paper or article) that gives the reader an overview of its purpose, scope and main points, enabling them to decide whether to read the full document. It is usually placed at the beginning and is written in a single, concise passage.

Descriptive vs Informative Abstract

Example difference: a descriptive abstract says "This report examines the causes of network congestion," whereas an informative abstract says "This report examines the causes of network congestion and finds that 70% arises from insufficient bandwidth; it recommends upgrading the backbone link."

Thus a descriptive abstract only tells what the document is about, while an informative abstract tells what the document says.

Jargon in Technical Writing

Jargon is the specialized or technical vocabulary used by people within a particular profession, trade or field — for example byte, bandwidth, algorithm, and latency in computing. These terms have precise meanings understood by insiders but are often unfamiliar to outsiders.

Use of Jargon in Technical Writing

When it is appropriate:

• When the audience consists of experts or specialists who share the same vocabulary, jargon enables precise, concise and efficient communication (one exact term replaces a long explanation).
• It reflects professional standards and avoids ambiguity within the field.

When it should be avoided or explained:

• For a general or lay audience, jargon causes confusion and reduces clarity; it should be replaced with plain words or defined on first use (e.g., in a glossary).
• Overusing jargon to sound impressive ("buzzwords") harms readability and credibility.

Guideline

The writer must judge jargon by audience analysis: use it only when readers will understand it; otherwise define it or use simpler language. The goal of technical writing is clear communication, not showing off specialized vocabulary.