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

Business Correspondence

Business correspondence is the exchange of written information between organizations, or between an organization and its clients, employees and stakeholders, to conduct business activities such as inquiries, orders, complaints and internal coordination.

Types of Business Correspondence

1. Internal correspondence — exchanged within the organization (memos, internal emails, circulars, notices).
2. External correspondence — exchanged with parties outside the organization (sales letters, inquiry letters, quotations, complaint and adjustment letters).
3. Sales / promotional correspondence — letters and mails meant to promote products or services.
4. Personalized / routine correspondence — order letters, acknowledgements, confirmations, follow-ups.
5. Circular correspondence — the same message sent to many recipients (announcements, policy changes).

Structure of a Business Letter

• Heading / Letterhead — sender's name and address.
• Date — date of writing.
• Inside address — recipient's name, designation, address.
• Salutation — e.g., Dear Sir/Madam.
• Subject line — concise statement of purpose.
• Body — opening (purpose), middle (details), closing (action expected).
• Complimentary close — e.g., Yours faithfully.
• Signature block — signature, name and designation.
• Enclosures / cc — if any.

Structure of a Memo

A memo is short internal communication using a fixed header format:

TO:      [recipient]
FROM:    [sender]
DATE:    [date]
SUBJECT: [topic]

Followed by a short body (purpose, discussion, action required). Memos omit salutation and complimentary close and are direct and concise.

Structure of an Email

• To / Cc / Bcc fields.
• Subject line — clear and specific.
• Salutation — Dear … or Hi ….
• Body — brief, focused, often in short paragraphs or bullets.
• Closing — Regards / Sincerely.
• Signature — name, designation, contact details.
• Attachments — referenced where relevant.

Emails are faster and less formal than letters but follow the same logic of clarity, courtesy and a single clear purpose.

Technical Writing

Technical writing is a form of writing that conveys complex, technical or specialized information clearly, accurately and concisely to a defined audience so that they can understand, use or act on it. Examples include user manuals, software documentation, research reports, proposals and instructions.

Characteristics of Technical Writing

1. Clarity — unambiguous language; one interpretation only.
2. Accuracy — facts, data and instructions must be correct.
3. Conciseness — no unnecessary words; says only what is needed.
4. Audience-centred — written for a specific reader and purpose.
5. Objectivity — fact-based, impersonal and free of emotion.
6. Structured format — uses headings, lists, tables, figures and consistent layout.
7. Plain, standard language — denotative, jargon controlled and defined.

How It Differs from Other Forms of Writing

Examples:

• Technical: "Press the Reset button for 5 seconds to restore factory settings." (instructional, exact)
• Literary: "The old machine sighed back to life as if waking from a long sleep." (expressive, figurative)

Thus, while literary writing values style and emotion, technical writing values clarity, accuracy and usefulness for the reader.

Audience Analysis

Audience analysis is the process of identifying and understanding the readers of a technical document — their knowledge level, needs, expectations, background and how they will use the document — so the writer can tailor content, language and format accordingly.

Importance of Audience Analysis

1. Determines content depth — decides how much background and detail to include.
2. Controls language and tone — sets level of vocabulary and technical jargon.
3. Improves usability — helps readers find and act on information quickly.
4. Increases effectiveness — the message achieves its intended purpose.
5. Avoids miscommunication — prevents content that is too simple or too complex.
6. Guides format and design — influences use of visuals, examples and structure.

Types of Audience

• Experts — deep subject knowledge; need precise technical detail.
• Technicians / Operators — apply instructions; need practical, step-by-step content.
• Managers / Executives — need summaries, conclusions and decisions.
• Laypersons / General users — limited knowledge; need plain language and explanations.

Process of Analyzing the Audience

1. Identify the audience — primary, secondary and gatekeeper readers.
2. Assess their knowledge level — expert, semi-technical or novice.
3. Determine their needs and purpose — what they want to do with the document.
4. Consider their background — education, culture, role and language.
5. Anticipate questions and expectations — what they already know vs. need to learn.
6. Decide the appropriate level, tone and format — based on the above findings.
7. Adapt the document — adjust vocabulary, detail, visuals and organization to match.

A careful audience analysis ensures the document is clear, relevant and usable for the people who actually read it.

Definition in Technical Writing

In technical writing, a definition explains the precise meaning of a term, concept or object so that readers share a common understanding. Definitions are essential because technical documents use specialized terms that may be unfamiliar or ambiguous to the audience.

Formal Definition

A formal (sentence) definition follows the pattern:

It places the term in a category and then states how it differs from other members of that category.

• Example: "A modem (term) is a device (class) that converts digital signals to analog and back for data transmission over telephone lines (distinguishing features)."

Informal Definition

An informal definition explains a term briefly using a synonym, a parenthetical phrase or an everyday word, without the strict class-and-differentia structure. It is used when only a quick clarification is needed.

• Example: "The cursor (the blinking marker on the screen) shows where the next character will appear."

Summary: A formal definition is precise and complete; an informal definition is short and convenient. Technical writers also use extended definitions (a paragraph or more) for complex terms needing examples, comparisons or background.

Coherence and Cohesion in Technical Documents

Coherence is the logical flow and overall sense of a document — ideas are arranged in a clear, sensible order so the reader can follow the line of thought. Cohesion is the grammatical and lexical "glue" that connects sentences and paragraphs — transition words, pronouns, repetition of key terms and parallel structure.

Importance

1. Easy understanding — coherent organization lets readers follow the argument without confusion.
2. Smooth flow — cohesive devices (e.g., therefore, however, as a result) link ideas so the text reads naturally.
3. Logical progression — each idea builds on the previous one, supporting the document's purpose.
4. Unity — keeps every sentence and paragraph focused on the central topic.
5. Reader retention — well-connected text is easier to remember and act upon.
6. Professional quality — coherent, cohesive writing appears credible and well-organized.

Ways to achieve them: logical ordering of information, clear topic sentences, transition words, consistent terminology, pronoun reference and parallel structure.

In short, coherence ensures the ideas make sense together, while cohesion ensures the words and sentences connect smoothly — together they make a technical document clear and readable.

Progress Report

A progress report is a document that informs readers about the status of an ongoing project or task — what work has been completed, what is currently in progress and what remains to be done within a given period. It is usually submitted periodically (weekly, monthly) to supervisors, clients or funding bodies.

Purpose of a Progress Report

1. Inform stakeholders of the current status of a project.
2. Show work completed during the reporting period.
3. Highlight problems or delays and how they are being addressed.
4. State remaining work and projected completion.
5. Help decision-making about resources, schedule and budget.
6. Maintain accountability and a record of progress over time.

Typical Structure

• Introduction — project name, objective, reporting period.
• Work completed — tasks finished so far.
• Work in progress — current activities.
• Work remaining / schedule — pending tasks and timeline.
• Problems and solutions — difficulties faced and actions taken.
• Conclusion — overall status and outlook.

Thus a progress report keeps everyone informed and the project on track.

Elements of a Good Instruction Manual

An instruction manual tells users how to operate, install, maintain or troubleshoot a product. A good manual has the following elements:

1. Clear title and introduction — states the product and the manual's purpose.
2. Table of contents — for easy navigation of sections.
3. List of parts / components — names and identifies items, often with labelled diagrams.
4. Safety warnings and cautions — highlighted notes about hazards before relevant steps.
5. Step-by-step instructions — numbered, in correct sequence, using clear imperative verbs ("Press", "Connect").
6. Visuals / illustrations — diagrams, screenshots and figures that support the text.
7. Specifications — technical details and requirements.
8. Troubleshooting section — common problems and solutions, often in a table.
9. Glossary and index — definitions of terms and quick lookup.
10. Consistent format and plain language — simple words, short sentences, consistent layout and audience-appropriate level.

A good manual is clear, accurate, complete, well-organized and easy to follow, enabling users to perform tasks safely and correctly.

Resume

A resume is a brief, formal document that summarizes a person's qualifications, skills, education and work experience, prepared to apply for a job and to convince an employer to grant an interview. It is concise (usually one to two pages) and tailored to the target position.

Essential Components of a Resume

1. Heading / Contact information — full name, address, phone number, email.
2. Career objective / Professional summary — short statement of goals or key strengths.
3. Educational qualifications — degrees, institutions and dates (usually most recent first).
4. Work experience — job titles, employers, dates and key responsibilities/achievements.
5. Skills — technical and soft skills relevant to the job.
6. Achievements / Awards — honours, certifications, projects.
7. Extracurricular activities / Interests — relevant additional involvement.
8. References — names of referees or "Available on request".

A good resume is clear, accurate, well-organized, error-free and tailored to the specific job.

Letter of Inquiry vs. Order Letter

In short: a letter of inquiry seeks information and places no obligation, whereas an order letter confirms a definite purchase with exact details and terms. The inquiry usually precedes the order in the buying process.

Role of Tone and Style in Technical Writing

Tone is the writer's attitude toward the subject and the reader, reflected in word choice and expression. Style is the manner of writing — sentence structure, vocabulary, level of formality and overall presentation.

Role of Tone

1. Professional and objective — technical writing keeps a neutral, respectful, fact-based tone.
2. Reader-appropriate — tone is adjusted to the audience (formal for clients, instructive for users).
3. Courteous — maintains goodwill, especially in correspondence and complaints.
4. Credible — a confident, impartial tone builds trust in the information.

Role of Style

1. Clarity — plain words and short, direct sentences make content easy to understand.
2. Conciseness — avoids wordiness; conveys ideas efficiently.
3. Consistency — uniform terminology, format and voice throughout the document.
4. Accessibility — appropriate vocabulary and structure suit the reader's level.

Together, the right tone keeps the document professional and reader-friendly, while a clear, concise style makes the information accurate and easy to use. Poor tone or style can confuse, alienate or mislead the reader, defeating the document's purpose.

Feasibility Report

A feasibility report is an analytical document that examines a proposed project, plan or solution and evaluates whether it is practical, viable and worth undertaking. It studies the problem, considers possible options and recommends the best course of action based on defined criteria.

Types of Feasibility Examined

1. Technical feasibility — can it be done with available technology and resources?
2. Economic / Financial feasibility — are the costs justified by the benefits?
3. Operational feasibility — will it work within the organization's processes?
4. Legal feasibility — does it comply with laws and regulations?
5. Schedule feasibility — can it be completed within the required time?

Typical Structure

• Introduction — problem and purpose of the study.
• Criteria / requirements — standards used to judge options.
• Analysis of alternatives — evaluation of each option against the criteria.
• Conclusions — findings from the analysis.
• Recommendation — whether and how to proceed.

Thus a feasibility report helps decision-makers decide whether a project should go ahead.

Use of Headings and Lists in Formatting Technical Documents

Headings and lists are formatting tools that organize information visually and make technical documents easier to read, navigate and understand.

Use of Headings

1. Show structure — divide the document into logical sections and sub-sections.
2. Aid navigation — let readers scan and jump to the part they need.
3. Signal hierarchy — heading levels (H1, H2, H3) show how topics relate.
4. Improve readability — break long text into manageable chunks.
5. Support indexing — enable a table of contents and quick reference.

Good practice: keep headings short, descriptive, parallel in form and consistently formatted.

Use of Lists

1. Highlight key points — emphasize items, steps or features.
2. Show sequence — numbered (ordered) lists for steps or ranked items.
3. Show grouped items — bulleted (unordered) lists for items without sequence.
4. Increase clarity — break complex information into separate, scannable items.
5. Save space and reduce density — replace long sentences with concise points.

Good practice: keep list items parallel in structure, roughly equal in length, and introduced by a clear lead-in.

Conclusion: Headings and lists improve clarity, organization and accessibility, helping readers locate and absorb information quickly — a core goal of technical writing.