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

Structure and Components of a Formal Technical Report

A formal technical report is a structured document that presents information, analysis and recommendations on a technical subject. It is conventionally organised into three major divisions: front matter, body and back matter.

1. Front Matter (Preliminary Pages)

These pages introduce the report and help the reader locate information. They are usually numbered with small Roman numerals (i, ii, iii).

• Cover / Title page – Report title, author's name, organisation, date and report number.
• Letter of transmittal – A covering letter handing the report to the recipient, stating purpose and scope.
• Table of contents – Lists headings with page numbers.
• List of figures and tables – Captions and page numbers of illustrations.
• Abstract / Executive summary – A concise summary of objectives, methods, findings and recommendations so a busy reader can grasp the report quickly.
• Acknowledgements and preface (optional).

2. Body (Main Text)

This is the substance of the report, numbered with Arabic numerals (1, 2, 3).

• Introduction – States the purpose, scope, background and problem definition.
• Methodology / Materials and methods – Describes how the work was carried out.
• Discussion / Findings / Results – Presents data, analysis, tables and figures, with interpretation.
• Conclusions – Summarises the main findings logically derived from the results.
• Recommendations – Suggests practical actions based on the conclusions.

3. Back Matter (Supplementary Pages)

Material that supports the body but would interrupt its flow.

• References / Bibliography – Cited and consulted sources in a standard style (APA, IEEE, etc.).
• Appendices – Raw data, derivations, questionnaires, large tables or code.
• Glossary – Definitions of technical terms and symbols.
• Index (in long reports).

Conclusion

The three-part structure ensures a report is complete, easy to navigate and professional: the front matter orients the reader, the body delivers the technical content, and the back matter provides supporting evidence and references.

Proposal

A proposal is a persuasive document written to convince a reader (a client, management, a funding agency or a committee) to approve a plan, project, product or service. It identifies a problem or need and offers a specific solution along with the resources, time and cost required.

Contents of a Proposal

A proposal typically answers what is to be done, why, how, when, by whom and at what cost. Core contents include:

• Statement of the problem or need
• Proposed solution / objectives and scope
• Methodology or plan of work
• Schedule / timeline
• Budget and resources
• Qualifications of the personnel/organisation
• Expected benefits and conclusion

Types of Proposals

Structure of a Formal Proposal

1. Front matter – Title page, letter of transmittal, table of contents, executive summary/abstract.
2. Body
   • Introduction – Background, statement of problem, purpose and scope.
   • Proposed solution / objectives
   • Methodology / plan of work
   • Schedule and milestones
   • Budget / cost estimate
   • Qualifications / personnel
   • Conclusion – Restating benefits and requesting approval.
3. Back matter – References and appendices (supporting data, CVs, drawings).

Conclusion

A proposal is essentially a persuasive plan; its success depends on clearly defining the problem and presenting a credible, well-costed solution within a logical formal structure.

The Writing Process in Technical Writing

The writing process is the systematic, recursive set of stages a writer follows to produce an effective technical document. It is not strictly linear—writers often loop back to earlier stages. The four main stages are planning, drafting, revising and editing.

1. Planning (Prewriting)

The preparatory stage where the writer decides what to write and how.

• Analyse purpose and audience – Why is the document written and who will read it?
• Gather information – Research, collect data, interview, observe.
• Generate and organise ideas – Brainstorming, outlining, grouping points.
• Decide scope and format – Report, proposal, manual, etc.

2. Drafting

The writer converts the plan into a first, complete version of the document.

• Write freely following the outline without worrying about perfection.
• Focus on getting all content and ideas down on paper.
• Maintain logical flow and cover every section.

3. Revising

Large-scale ("global") improvement of content and organisation.

• Check whether the purpose is met and the audience's needs are satisfied.
• Add, delete, reorder or rewrite sections for clarity and completeness.
• Improve coherence, logic, paragraph structure and tone.
• Often the writer returns to planning if gaps are found.

4. Editing (and Proofreading)

Small-scale ("local") refinement of the language and surface details.

• Correct grammar, spelling, punctuation and word choice.
• Ensure consistency in style, terminology, formatting and references.
• Check figures, tables, captions and citations.
• Proofreading is the final read for any remaining typographical errors.

Conclusion

Planning shapes the document, drafting produces it, revising improves its content and organisation, and editing polishes its language. Because writing is recursive, moving back and forth between these stages yields a clear, accurate and professional technical document.

Technical Writing vs. Creative Writing

Summary: Technical writing is fact-based, objective and audience-specific aimed at conveying information accurately, whereas creative writing is imaginative, subjective and expressive aimed at entertaining or moving the reader.

News Release

A news release (or press release) is a short, official written statement issued by an organisation to the news media announcing something newsworthy—such as a new product, event, achievement or policy—so that it may be published or broadcast.

Structure of a News Release

1. Letterhead / Heading – Organisation's name and logo, with the words "News Release" or "Press Release."
2. Release date / instruction – e.g. "FOR IMMEDIATE RELEASE" or a release date.
3. Headline – A short, catchy title summarising the news.
4. Dateline – City and date of issue, beginning the first paragraph.
5. Lead paragraph – The opening that answers the 5 Ws and H (Who, What, When, Where, Why, How)—the most important information first (inverted-pyramid style).
6. Body – Supporting details, quotations from officials, and background information in decreasing order of importance.
7. Boilerplate – A short standard paragraph describing the organisation.
8. Contact information – Name, phone and email of the media contact.
9. End notation – "###" or "-30-" marking the end.

Note: A news release follows the inverted pyramid so editors can cut from the bottom without losing key facts.

The Seven Cs of Effective Communication

The Seven Cs are principles that make written or spoken communication clear and effective.

1. Clarity – The message should be clear and easy to understand; use simple words and one idea per sentence.
2. Conciseness – Convey the message in as few words as possible, avoiding wordiness and repetition.
3. Concreteness – Be specific and definite, supported by facts and figures rather than vague statements.
4. Correctness – Use correct grammar, spelling, facts and figures; the right level of language for the audience.
5. Completeness – Include all necessary information so the receiver can act—answer all questions (the 5 Ws and H).
6. Consideration (Courtesy combined) – Consider the receiver's viewpoint, needs and feelings; adopt a "you-attitude."
7. Courtesy – Be polite, respectful and sincere in tone.

(Some texts list Consideration and Courtesy as separate; together they ensure the message is both audience-centred and polite.)

Summary: Following the Seven Cs—Clarity, Conciseness, Concreteness, Correctness, Completeness, Consideration and Courtesy—ensures messages are understood accurately and produce the desired response.

Informative Brief

An informative brief is a short, concise document that presents factual information about a subject, situation or issue so that the reader is informed and can understand or make a decision. Unlike a persuasive brief, it does not argue a case—its sole aim is to convey information clearly and objectively.

Characteristics

• Short and focused on facts.
• Objective and neutral tone.
• Well organised, usually with headings and bullet points.
• Summarises key points for quick reading.

Typical Structure

• Title / subject
• Purpose / background
• Key facts or findings
• Summary / conclusion

Example

Subject: New Library Management Software

Purpose: To inform staff about the system being installed next month.

Key facts: The new software automates book issue/return, supports online catalogue search, and generates overdue reports. Training will be held on 15th of next month. It replaces the current manual register.

Here the brief simply states the facts about the software and training—no persuasion is involved—making it a clear example of an informative brief.

Formal Reports vs. Informal Reports

Summary: A formal report is long, structured and impersonal, used for important or external matters, whereas an informal report is short, flexible and personal, used for routine internal communication.

Memorandum (Memo)

A memorandum (memo) is a short, written internal message used to communicate within an organisation—for example to announce information, give instructions, request action or record decisions. It is less formal than a letter and circulates among members of the same organisation.

Format of a Memo

A memo has two parts: the heading and the body.

1. Heading

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

2. Body

• Opening – States the purpose of the memo.
• Discussion – Gives the details, facts or instructions.
• Closing – States the action required, a request or a courteous ending.

Features

• No salutation ("Dear...") or complimentary close as in letters.
• Direct, concise and to the point.
• Usually initialled by the sender beside the FROM line rather than fully signed.

Summary: A memo is an internal communication tool with a fixed four-line heading (To, From, Date, Subject) followed by a brief body covering purpose, details and required action.

Importance of Revising and Editing in Technical Writing

Revising improves the content and organisation of a draft, while editing refines its language and surface details. Both are essential to produce a clear, accurate and professional document.

Importance

• Ensures accuracy – Removes factual errors, wrong data and inconsistencies that could mislead readers or cause costly mistakes.
• Improves clarity – Rewriting confusing sentences and reorganising content makes the message easy to understand.
• Enhances completeness – Revising reveals missing information or gaps so all reader questions are answered.
• Strengthens organisation and coherence – Ideas are arranged logically with smooth transitions.
• Corrects language errors – Editing fixes grammar, spelling, punctuation and word choice, increasing readability.
• Maintains consistency – Uniform style, terminology, formatting and references throughout the document.
• Builds credibility and professionalism – An error-free document gains the reader's trust and reflects well on the writer/organisation.

Summary: Revising guarantees the right content in the right order; editing guarantees correct, polished language. Together they transform a rough draft into an effective, trustworthy technical document.

Abstract

An abstract is a brief, self-contained summary of a longer document (report, paper or thesis) that states its purpose, main points and findings, enabling readers to decide quickly whether to read the full document. It usually appears at the beginning of the report.

Descriptive vs. Informative Abstracts

Summary: A descriptive abstract merely describes the topics covered, while an informative abstract summarises the actual content including findings and conclusions, and can stand in for the full report.

Jargon in Technical Writing

Jargon is the specialised or technical vocabulary, terms and abbreviations used by a particular profession, trade or group (e.g. RAM, bandwidth, debugging in computing). It allows experts to communicate complex ideas precisely and efficiently among themselves.

Appropriate Use in Technical Writing

• Use jargon when the audience is expert – Among specialists it is precise, concise and saves explanation (e.g. a manual written for programmers).
• Avoid or define jargon for non-expert audiences – For general or mixed readers, unfamiliar jargon causes confusion; replace it with plain words or define it on first use.
• Be consistent – Use the same term for the same concept throughout.

Advantages

• Precise and unambiguous within the field.
• Economical—one term replaces a long explanation.

Disadvantages

• Confuses readers outside the field.
• Can make writing sound exclusive or pompous if overused.

Summary: Jargon is field-specific terminology that aids precise communication among experts, but in technical writing it must be matched to the audience—used freely with specialists and avoided or explained for lay readers.