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

Recommendation Report vs. Proposal

What is a Recommendation Report?

A recommendation report is a formal analytical report that studies a problem or set of options, evaluates them against defined criteria, and recommends the best course of action. It is written after an evaluation has been done and is backed by evidence, comparison and reasoning.

How It Differs from a Proposal

---

Recommendation Report: Cloud Storage Solution for a 50-Employee Business

TO: Managing Director, [Client Company] FROM: [Your Name], IT Consultant, [Consulting Firm] DATE: 15 June 2026 SUBJECT: Recommendation of a Cloud Storage Solution

1. Problem Statement

The client, a 50-employee business, currently lacks a centralized, secure and scalable file-storage system. Files are scattered across local drives and personal accounts, causing version conflicts, data-loss risk, weak access control and poor collaboration. The client needs one cloud storage platform that is secure, easy to administer, cost-effective for 50 users, and well integrated with the tools they already use.

2. Evaluation Criteria

The three solutions were assessed against five weighted criteria:

1. Cost (per user / month for business plan)
2. Storage capacity (per user / pooled)
3. Security & admin controls (encryption, 2FA, access management)
4. Collaboration & integration (real-time editing, app ecosystem)
5. Ease of use & support

3. Detailed Analysis

• Google Drive: Best for browser-based, real-time collaboration; strong value when bundled with Workspace; simple administration.
• Dropbox: Best-in-class file sync and reliability, but costs more and offers a smaller productivity-app ecosystem.
• OneDrive: Strongest fit for organizations already using Microsoft Office/Teams; deep enterprise security controls.

4. Recommendation and Justification

For a 50-employee business, I recommend Microsoft OneDrive (Microsoft 365 Business Standard) if the client already relies on Office documents and Teams, because it bundles storage, email, Office apps and meetings into one cost-effective subscription with enterprise-grade security and centralized admin.

If the client prefers a browser-first, low-maintenance environment with the easiest collaboration, Google Workspace (Drive) is the recommended alternative.

Justification: Both options deliver the required security (encryption + 2FA), scale cleanly to 50 users, and reduce total cost by bundling productivity apps—whereas Dropbox, though excellent at sync, is costlier and narrower in scope for the same budget.

5. Conclusion

OneDrive/M365 (or Google Workspace as the alternative) best satisfies the client's needs for security, collaboration, scalability and value. We recommend a 30-day pilot with 5 users before full rollout.

The Technical Writing Process and Collaborative Writing

Part A: The Complete Technical Writing Process (Planning to Publishing)

Technical writing follows a structured, iterative process. The main phases are:

1. Planning / Prewriting

• Define the purpose and audience (audience analysis).
• Determine scope, medium and deliverables.
• Gather information through research, interviews and source review; create an outline and schedule.

2. Drafting

• Convert the outline into a first draft, focusing on getting content down.
• Organize logically with headings, sections and placeholder visuals.

3. Revising

• Improve content and structure (the big picture): completeness, accuracy, organization, clarity and audience fit.
• Reorder, add or cut material.

4. Editing / Copyediting

• Correct grammar, spelling, punctuation, terminology and formatting consistency.

5. Proofreading

• Final surface check for typos, layout and visual errors before release.

6. Publishing / Distributing

• Produce the final document in the chosen format (PDF, web/help, print) and deliver it to the audience; maintain and update it.

Plan -> Draft -> Revise -> Edit -> Proofread -> Publish -> (Maintain)
      ^___________ feedback loop ___________|

Part B: Collaborative Writing

Collaborative writing is when two or more people contribute to producing a single document—common in software documentation where writers, developers, QA and subject-matter experts (SMEs) work together.

Advantages

• Diverse expertise: Developers supply accuracy, writers supply clarity.
• Shared workload & speed: Large docs (e.g., an API reference) finish faster.
• Higher quality: Multiple reviewers catch errors and gaps.
• Consistency through review: Peer review enforces style and standards.

Challenges (how it complicates the process)

• Inconsistent voice/style across authors.
• Version-control conflicts when many edit the same file.
• Coordination overhead (scheduling, merging, ownership).
• Disagreements on content, tone or technical accuracy.

Conflict-Resolution Strategies

1. Define roles & ownership early (lead writer, reviewers, SME approvers).
2. Agree on a style guide so style disputes are settled by a standard.
3. Use collaboration tools (Git, Confluence, Google Docs) for version control and tracked changes.
4. Hold review meetings and use a clear approval/sign-off workflow.
5. Escalate factual disputes to the SME; resolve style disputes via the guide; use the lead writer or manager as final arbiter.

IT Example

When documenting a new REST API, developers draft endpoint details, the technical writer rewrites for clarity, QA verifies the examples, and changes flow through Git pull requests with peer review. A shared style guide and PR approvals keep the voice consistent and resolve conflicts objectively.

Conclusion

The writing process moves systematically from planning to publishing with feedback loops. Collaboration enhances quality and speed through shared expertise but complicates the process with coordination, consistency and conflict issues—best managed by clear roles, a style guide, version-control tools and defined approval workflows.

Proposal: Website Redesign for [Software Company], Nepal

TO: Management, [Software Company] FROM: Web Content Manager SUBJECT: Proposal to Improve User Experience, Accessibility and SEO

Introduction

This proposal outlines a plan to redesign the company website to improve user experience (UX), accessibility and search engine visibility (SEO). It addresses page design, web content, information architecture and accessibility.

(a) Key Principles for Organizing and Designing Web Pages

• Visual hierarchy: Most important elements (value proposition, CTA) get the most prominence through size, color and position.
• Consistency: Uniform navigation, colors, fonts and layout across pages.
• Scannability: Short paragraphs, headings, white space and bullet lists for F-pattern reading.
• Responsive, mobile-first design: Layout adapts to phones, tablets and desktops.
• Fast loading & clear navigation: Optimized images, simple menus, visible CTAs.
• Example: The homepage leads with "Custom Software Development for Growing Businesses" and a single "Get a Quote" button above the fold.

(b) Best Practices for Writing Effective Web Content

• Plain language and concise, benefit-focused copy.
• Front-loaded information (inverted pyramid)—key point first.
• Scannable structure: descriptive headings, short paragraphs, bullets.
• Action-oriented CTAs ("Request a Demo").
• SEO-aware writing: natural keywords, descriptive titles, meta descriptions, alt text.
• Example: Instead of "We leverage synergistic solutions," write "We build web and mobile apps that cut your operating costs."

(c) Information Architecture (IA) Considerations

• Logical grouping of content (Services, Products, Case Studies, About, Contact, Blog).
• Shallow hierarchy so any page is reachable in ~3 clicks.
• Clear navigation & breadcrumbs; consistent labeling.
• Search function and an HTML/XML sitemap.
• URL structure that is readable and keyword-friendly (/services/mobile-app-development).
• Example: Group all offerings under a "Services" mega-menu rather than scattering them.

(d) Ensuring Web Accessibility (for users with disabilities)

Follow WCAG guidelines (POUR: Perceivable, Operable, Understandable, Robust):

• Alt text for all images and meaningful icons.
• Sufficient color contrast and not relying on color alone.
• Keyboard navigability and visible focus states.
• Semantic HTML & ARIA labels for screen readers.
• Captions/transcripts for video and audio.
• Resizable text and clear, descriptive link text.
• Example: A blind user can navigate the "Contact" form using a screen reader because every field has a proper label.

Conclusion

Applying sound page-design principles, plain effective content, a logical information architecture and WCAG accessibility will make the redesigned site easier to use, reachable by all users, and more visible in search—directly supporting the company's growth.

Ethics in Technical Writing and Workplace Communication

Importance of Ethics

Ethics in technical writing means communicating honestly, accurately and responsibly, respecting the rights of readers, the organization and the public. It is important because:

• Technical documents (safety guides, software docs) can directly affect users' safety, money and decisions.
• Ethical writing builds trust and credibility for the writer and organization.
• It ensures legal compliance (copyright, data protection, accessibility) and protects users from harm caused by misleading information.

Ethical Dilemmas in the IT Industry

• Inaccurate or exaggerated claims about product features, performance or security.
• Plagiarism of code samples, documentation or copyrighted content.
• Hiding known bugs or vulnerabilities from users.
• Privacy issues: documenting how user data is collected/used.
• Pressure from management to overstate benefits or downplay risks.
• Misleading visuals (charts that distort data).

Steps When Confronted with an Ethical Issue

1. Identify and verify the facts of the problem (e.g., confirm the information is truly inaccurate).
2. Consult the code of conduct / company policy and relevant standards.
3. Raise the concern internally first—inform your supervisor in writing with evidence and a recommended fix.
4. Document everything (dates, communications, evidence).
5. Propose corrective action (correction, retraction, disclosure).
6. Escalate to higher management or, as a last resort, whistleblow to an authority if the wrongdoing is serious and ignored.
7. For plagiarism, cite/attribute sources or rewrite original content; for inaccuracy, correct and republish.

How Organizations Can Create a Culture of Ethics

• Establish a clear code of ethics and communication policy.
• Provide ethics training and a style/standards guide.
• Create safe, anonymous reporting channels (whistleblower protection).
• Lead by example—management models honest communication.
• Reward integrity and enforce accountability for violations.

Real-World Examples

• Volkswagen emissions scandal: falsified technical data misled regulators and customers—an ethics failure with massive legal cost.
• Software vulnerability disclosures: ethical companies (responsible disclosure) inform users and patch quickly rather than hide flaws.

Conclusion

Ethics is central to technical writing because inaccurate or dishonest documents can cause real harm. Writers should verify facts, avoid plagiarism, raise concerns through proper channels, and—when necessary—whistleblow, while organizations sustain ethics through codes, training, safe reporting and accountable leadership.

Technical vs. Academic vs. Creative Writing

Unique Characteristics That Make Technical Writing Essential

1. Audience-centred and task-oriented: It helps real users do real things (install software, operate a device).
2. Clarity and precision: Removes ambiguity so instructions are followed correctly.
3. Accuracy: Correct facts and data prevent costly or dangerous errors.
4. Conciseness: Saves the busy professional reader's time.
5. Use of visuals and standard formats: Makes complex information accessible.

Why essential in professional contexts: Modern workplaces depend on documents—manuals, reports, proposals, specifications—to operate products, comply with standards and make decisions. Without clear technical writing, knowledge cannot be transferred reliably, leading to errors, wasted time and risk.

Audience Analysis

What is Audience Analysis?

Audience analysis is the process of studying and understanding the readers of a technical document—their knowledge level, needs, expectations, role, background and how they will use the information—before and while writing. It answers: Who will read this, what do they already know, and what do they need to do with it?

Audiences are often classified as:

• Experts (deep technical knowledge),
• Technicians/operators (apply instructions),
• Managers (need decisions/summaries),
• Non-specialists/general users (need plain language).

How Understanding the Audience Affects:

1. Purpose – Knowing the audience clarifies why you write: to instruct end-users, to persuade managers, or to inform engineers. A manager's report aims at decisions; a user guide aims at task completion.

2. Scope – The audience determines how much and what to include. Experts need depth and technical detail; beginners need background, definitions and step-by-step explanation. You leave out what they already know and add what they lack.

3. Medium – The audience shapes the format and channel: a quick email or memo for colleagues, a printed/PDF manual for end-users, online help for software users, a slide deck for executives.

IT Industry Example

For a new database tool, the same product needs different documents for different audiences:

• Developers get a detailed API reference (technical, code samples).
• End-users get a simple step-by-step user guide (screenshots, plain language).
• Managers get a one-page executive summary (benefits, cost, ROI).

Audience analysis ensures each version has the right purpose, scope and medium.

Conclusion

Audience analysis is the foundation of effective technical writing: by understanding readers first, the writer sets the right purpose, includes the right scope, and chooses the right medium—producing documents that truly meet the reader's needs.

Gantt Chart: 12-Week Mobile App Development Project

A Gantt chart is a horizontal bar chart that shows project tasks against a timeline, displaying start/end dates, durations, dependencies and milestones.

Project Schedule

Dependencies are finish-to-start (each phase begins when the previous one ends).

Gantt Chart (ASCII)

Phase                | W1  W2  W3  W4  W5  W6  W7  W8  W9  W10 W11 W12
---------------------|------------------------------------------------
1 Requirement Gather |###  ###
2 UI/UX Design       |         ### ###
3 Development        |                 ###  ### ### ### ###
4 Testing            |                                     ### ###
5 Deployment         |                                             ###
---------------------|------------------------------------------------
Milestones           |   M1      M2              M3         M4   M5

Milestones

• M1 (End W2): Requirements signed off (SRS approved).
• M2 (End W4): UI/UX design approved.
• M3 (End W9): Development complete (feature-complete build).
• M4 (End W11): Testing complete (QA sign-off).
• M5 (End W12): App deployed / released to store.

Conclusion

The chart shows a sequential 12-week plan where each phase depends on the previous one, with five milestones marking key approvals and the final release—giving the team a clear view of timing and dependencies.

Copyediting and Publishing Phase

The Copyediting and Publishing Phase

This is the final stage of the writing process, where a revised draft is polished and prepared for release.

• Copyediting focuses on the language and consistency of the text: correcting grammar, spelling, punctuation, word choice, terminology, style and formatting so the document is correct and consistent.
• Publishing is producing and distributing the finished document in its final form—formatting/typesetting, applying templates, generating output (PDF, web/help, print) and delivering it to the audience, followed by maintenance/updates.

Key Differences: Copyediting vs. Proofreading vs. Peer Review

Conclusion

In the copyediting and publishing phase, copyediting refines language and consistency while publishing produces the final deliverable. Copyediting fixes language, proofreading is the final error sweep, and peer review checks the substance and accuracy of the content—each plays a distinct role in producing a professional document.

Chronological vs. Functional Resumes

When to Use Each

• Chronological: Use when you have a consistent, progressive work history in the same field—it clearly shows growth and is preferred by most employers.
• Functional: Use when you are a career changer, have employment gaps, or are a fresher with strong skills but limited experience—it highlights what you can do rather than where you worked.

Brief Functional Resume (Technical Writer)

RAMESH SHRESTHA
Kathmandu, Nepal | +977-98XXXXXXXX | ramesh.tw@email.com

CAREER OBJECTIVE
Detail-oriented Technical Writer seeking to create clear, user-focused
software documentation that improves user experience.

KEY SKILLS
- Documentation: User manuals, API docs, online help, SOPs
- Tools: Markdown, MS Word, Confluence, Git, MadCap Flare
- Communication: Plain language, audience analysis, editing
- Visuals: Diagrams, screenshots, flowcharts, tables

SELECTED ACHIEVEMENTS
- Authored a 60-page user guide that cut support tickets by 30%.
- Standardized documentation using a company style guide.
- Collaborated with developers via Git to document a REST API.

EDUCATION
BSc CSIT, Tribhuvan University

REFERENCES
Available on request.

Conclusion

A chronological resume showcases career history and is best for steady professionals, while a functional resume showcases skills and suits career changers or freshers. For a technical-writer role with skills to highlight, the functional format above puts competencies first.

Information Architecture and Writing Web Pages

What is Information Architecture (IA)?

Information architecture in web design is the practice of organizing, structuring and labeling content on a website so that users can find information easily and complete tasks efficiently. It defines the site's navigation, hierarchy, grouping of content, labeling and the relationships between pages. Good IA makes a site findable, usable and logical (often built using sitemaps, navigation menus, categories and search).

Key IA elements: organization systems (grouping), navigation systems (menus), labeling systems (clear names), and search systems.

Special Considerations for Different Web Pages

1. Homepage

• Communicate who you are and what you offer within seconds.
• Lead with a clear value proposition and a primary call-to-action (CTA).
• Provide clear navigation to key sections; keep it scannable and uncluttered.

2. Product Page

• Focus on benefits and features, specifications and clear images.
• Include CTA (Buy/Try/Request demo), pricing and social proof (reviews/ratings).
• Use scannable structure: headings, bullet lists of features, FAQs.

3. FAQ Page

• Group questions by topic/category; phrase them in the user's own words.
• Give concise, direct answers; link to detailed pages where needed.
• Make it searchable and easy to scan (accordions/anchor links).

Conclusion

Information architecture organizes and labels web content for easy access. Each page type has different goals—the homepage orients and converts, the product page persuades with benefits and CTAs, and the FAQ page answers user questions concisely—so writing must be tailored to each page's purpose.

News Release: Cybersecurity Software Launch

The inverted pyramid places the most important information first (the lead), followed by supporting details and background in decreasing order of importance.

FOR IMMEDIATE RELEASE

[Company Logo]

SecureShield Launches AI-Powered Cybersecurity Software to
Protect Businesses from Rising Cyber Threats

KATHMANDU, June 15, 2026 — SecureShield Technologies today
announced the launch of SecureShield Defender, an AI-powered
cybersecurity platform that detects and blocks cyber threats in
real time, helping businesses of all sizes protect their data
and systems against ransomware, phishing and zero-day attacks.

As cyberattacks on Nepali and global businesses rise sharply,
SecureShield Defender uses machine learning to identify threats
the moment they appear, reducing breach-response time from hours
to seconds. The software offers automated threat detection,
24/7 monitoring, and an easy-to-use dashboard that requires no
specialized security expertise to operate.

"Every business deserves enterprise-grade protection without
enterprise-grade complexity," said [CEO Name], CEO of
SecureShield Technologies. "SecureShield Defender makes advanced
security simple, affordable and instant."

Key features include real-time threat intelligence, automated
incident response, cloud and on-premise deployment, and seamless
integration with existing IT systems. The product is available
immediately with a 30-day free trial.

About SecureShield Technologies
SecureShield Technologies is a Nepal-based cybersecurity company
building intelligent tools that protect organizations from
evolving digital threats.

Media Contact:
[Name] | press@secureshield.com | +977-98XXXXXXXX

###

(Word count: under 300, persuasive, inverted-pyramid structure.)

Notes on Structure

• Headline + dateline + lead answer who/what/when/where/why first.
• Body gives supporting details and a quotation, then features.
• Boilerplate ("About"), contact info and ### end mark close the release.

Designing Effective Graphics for Technical Documents

Key Principles of Effective Graphics

1. Purpose-driven: Each visual must serve a clear communication goal, not decoration.
2. Clarity & simplicity: Avoid clutter; show only essential data (high data-ink ratio).
3. Accuracy & honesty: Scales and proportions must not distort or mislead.
4. Proper labeling: Title, axis labels, legend, units and a figure number/caption.
5. Consistency: Uniform colors, fonts and style across all graphics.
6. Integration with text: Reference and place the graphic near the relevant text.
7. Accessibility: Sufficient contrast; don't rely on color alone.

Choosing the Right Graphic

Factors to Consider When Choosing

• Type of data (exact vs. comparative vs. trend vs. process).
• Audience (experts may prefer tables; general readers prefer infographics).
• Purpose (compare, show change, explain a process, or summarize).
• Number of variables and the medium (print vs. web).

Conclusion

Effective graphics are purposeful, clear, accurate and well-labeled. The choice depends on the data and audience: tables for exact values, bar charts for comparisons, line graphs for trends, flowcharts for processes, and infographics for engaging summaries.

Memo: Inaccurate Safety Information in Documentation

MEMORANDUM

TO:      [Supervisor Name], Documentation Manager
FROM:    [Your Name], Technical Writer
DATE:    15 June 2026
SUBJECT: Urgent: Inaccurate Safety Information on Software
         Vulnerability in Published Documentation

Purpose This memo reports a serious inaccuracy in our published technical documentation that could harm users, and recommends immediate corrective action.

Situation While reviewing the user documentation for [Product/Version], I found that the security section contains inaccurate safety information about a known software vulnerability (CVE/issue ref: ____). The current text understates the risk and gives an incorrect mitigation step. As written, users following our instructions remain exposed to the vulnerability, which could lead to data loss or a security breach.

Impact

• Users may believe they are protected when they are not.
• Potential harm to users, legal liability and damage to company reputation.

Recommended Corrective Action

1. Immediately flag/withdraw the affected section from the live documentation.
2. Publish a corrected mitigation procedure verified by the security/development team.
3. Notify affected users (release note / security advisory) about the correction.
4. Review related documents for the same error and update the change log.

Request Given the safety risk, I request your approval to begin the correction today. I am ready to coordinate with the security team and prepare the updated content immediately.

Thank you for your prompt attention.

[Your Name] Technical Writer

Definitions

a) White Paper

A white paper is an authoritative, in-depth report that explains a problem and presents a solution, product or technology to inform and persuade decision-makers. In IT it is often used to promote a technology or approach by combining facts, analysis and arguments (e.g., a vendor's white paper on "Why Move to Cloud Computing").

b) Usability Testing

Usability testing is a method of evaluating a product, document or interface by observing real users as they try to complete typical tasks. It identifies where users struggle so the design or documentation can be improved for ease of use, efficiency and satisfaction.

c) Stakeholder Analysis

Stakeholder analysis is the process of identifying all the people or groups affected by or interested in a project (users, clients, managers, developers, regulators) and assessing their needs, influence and expectations. It helps the writer/team plan communication and content to satisfy each stakeholder.

d) Content Management System (CMS)

A Content Management System (CMS) is software that lets users create, edit, organize, store and publish digital content (especially web content) without deep technical/coding knowledge. Examples: WordPress, Drupal, Joomla. It supports collaboration, version control and easy updates.

e) Plain Language

Plain language is a style of writing that is clear, simple and easy to understand on the first reading by the intended audience. It uses common words, short sentences, active voice and logical structure, avoiding jargon and complexity—essential for accessible, user-friendly technical documents.

Short Notes

a) Whistleblowing in Technical Communication

Whistleblowing is the act of exposing or reporting unethical, illegal or unsafe practices within an organization to internal authorities or external bodies (regulators, media). In technical communication it arises when a writer discovers, for example, falsified data, hidden product defects, suppressed safety risks or fraud, and chooses to report it in the public interest.

• When to whistleblow: After internal channels (supervisor, management) fail and the wrongdoing threatens public safety or the law.
• Best practice: Raise concerns internally first, document evidence, follow company/ethics policy, and report responsibly.
• Significance: It upholds honesty, accountability and public safety, though it can carry personal risk—hence whistleblower-protection laws exist.

b) Mechanism Description vs. Process Description

Both are common technical descriptions but with different focus.

• A mechanism description explains the structure and components of an object/device (e.g., parts of a CPU).
• A process description explains a sequence of events or actions, either how something works or how to do it (e.g., how a compiler converts source code to machine code).