Technical Writing

Collaborative writing is the process in which two or more people work together to plan, draft, revise and finish a single document, sharing responsibility and ownership of the final product. It is common in the workplace for proposals, reports, manuals and websites, and may be done in one place or online using tools such as Google Docs, Microsoft 365 or Git.

Advantages of writing in teams

1. More expertise and knowledge: members contribute different skills and sections (technical, financial, design, language), producing a more complete and accurate document.
2. Better quality: ideas are discussed and criticised, errors are caught by several readers, and the result is more creative and balanced.
3. Saves time: the work is divided and done in parallel, helpful for large documents and tight deadlines.
4. Workload and risk sharing: the burden is shared, and if one member is absent others can continue.
5. Diverse viewpoints: helps address different readers and avoids personal bias.
6. Learning and skill development: members learn from each other and improve communication, negotiation and leadership skills.
7. Commitment and acceptance: shared ownership increases the motivation and support of the team for the final document.
8. Consistency and review built in: peer feedback occurs throughout the writing.

Cautions: it needs a clear plan, defined roles, a style guide, regular meetings, version control and conflict resolution, otherwise inconsistency, delays and conflicts can occur.

Document version control is the systematic management of changes made to a document over time, so that every draft or revision can be identified, compared, retrieved and attributed to its author. It avoids confusion in which people work on or send an outdated copy, avoids overwriting others' changes, and provides an audit trail, which is essential in technical writing and team projects (reports, manuals, software documentation). Tools include Git, SVN, SharePoint, Google Docs history and track changes in Word.

Parts of version control

1. Version numbering: a scheme that identifies each version, e.g. 1.0, 1.1, 2.0 (major.minor), or draft v0.3, with the date. Major numbers show big changes and minor numbers small edits.
2. Naming conventions: consistent file names such as Report_ProjectX_v2.1_2082-06-15.docx.
3. Revision history / change log: a table at the start of the document listing the version, date, author, a summary of the changes and the approver.
4. Check-in/check-out (access control): a controlled way to take a document for editing so that two people do not edit simultaneously, with locking or merging.
5. Repository/storage and backup: a central place keeping all versions, so that older ones can be restored (rollback).
6. Comparison and tracking of changes: highlighting differences between versions (track changes, diff).
7. Approval and release status: states such as draft, under review, approved, final, obsolete.
8. Distribution control: making sure only the current approved version is circulated and old copies are marked or archived.

Importance of revision

Revision means re-seeing and improving a draft after it is written. A first draft rarely communicates well; revision is important because it:

• improves clarity, accuracy and completeness, catching factual, technical and logical errors that could cause costly or dangerous misunderstanding;
• ensures the document meets the purpose and the audience's needs (right level, tone and detail);
• improves organisation, coherence and conciseness by removing redundancy and unnecessary words;
• corrects grammar, spelling, punctuation and format, which gives a professional image and credibility;
• ensures consistency of terms, style, numbers and design, and compliance with the organisation's standards.

Stages of revision

1. Allow a gap: put the draft aside to see it freshly.
2. Global (macro) revision: check purpose, audience, content, completeness, organisation and logical flow; add, delete or rearrange sections.
3. Substantive/Style revision: improve paragraphs and sentences, so that they are clear, concise, direct, with suitable word choice, tone and active voice.
4. Editing: check correctness of grammar, usage, spelling, punctuation, consistency, headings, lists and visuals.
5. Design/format review: check layout, fonts, captions, references, page numbers and table of contents.
6. Proofreading: final careful reading of the finished copy for typing and printing errors.
7. Peer/supervisor review and feedback: others read and comment, then the writer incorporates the changes.

Replacing the Fuel Filter

Introduction: A clogged fuel filter reduces engine power and causes hard starting. Replace it according to the manufacturer's interval (generally every 20,000 to 40,000 km). Time required: about 30 to 45 minutes.

Warning: Fuel is flammable. Work outdoors or in a well-ventilated area, away from sparks and flames; do not smoke. Wear safety glasses and gloves.

Tools and materials: new fuel filter (correct model), wrenches/spanners, screwdriver, fuel-line disconnect tool (if required), drain pan, rags, new clamps or O-rings.

Steps

1. Park the vehicle on level ground, apply the parking brake, and switch off the engine; let it cool.
2. Disconnect the negative (-) battery terminal.
3. Locate the fuel filter (in the fuel line under the vehicle or in the engine bay) and check the flow direction arrow.
4. Release the fuel system pressure: remove the fuel pump fuse or relay, start the engine and let it stall.
5. Place the drain pan under the filter and wrap a rag around the fittings.
6. Loosen the clamps or use the disconnect tool to detach the fuel lines from both ends of the filter. Let the fuel drain.
7. Remove the filter from its bracket.
8. Install the new filter with the arrow pointing toward the engine (in the direction of the fuel flow), with new O-rings if supplied.
9. Reconnect the fuel lines and tighten the clamps securely.
10. Reinstall the fuse/relay and reconnect the battery.
11. Turn the ignition on and off two or three times to pressurise the system, then check for leaks. Start the engine and check again.
12. Dispose of the old filter and fuel at an authorised recycling point.

Proposal to Improve Library Facilities at Our College

Submitted to: The Principal, ABC College Submitted by: Student Representative, BIT Fifth Semester Date: 2082-06-20

1. Introduction and problem Our college library has only about 20 seats for more than 600 students, limited current reference books, and no reliable internet. During examinations students stand in queues or study elsewhere, so reading time is lost and performance suffers.

2. Objective To make the library a comfortable, resource-rich study place for all students within six months.

3. Proposed solution

• Add 40 seats and tables with proper lighting.
• Purchase 150 new books and subscribe to two journals/e-resources.
• Install a Wi-Fi network and 5 computers.
• Extend opening hours to 7 am to 7 pm during exams.

4. Method and schedule

• Month 1: survey of needs, approval, quotations.
• Months 2-3: purchase of furniture, books and equipment.
• Months 4-5: installation, staff training.
• Month 6: opening and feedback.

5. Budget (estimate)

6. Benefits Better study environment, more resources, improved results and a stronger reputation for the college.

7. Conclusion We request approval and support so that the library can serve the needs of every student.

[Student Name] BIT Fifth Semester ABC College, Kathmandu Date: 2082-06-20

The Principal ABC College Kathmandu

Subject: Request for logistic support for a program on the impact of social media overuse on youths

Respected Sir/Madam,

With due respect, I would like to inform you that the Students' Club of our college plans to organise a one-day awareness program entitled "Impact of Social Media Overuse on Youths" on 2082-07-10 (Friday) from 11:00 am to 3:00 pm. The program aims to make students aware of the effects of excessive social media use on health, studies and relationships, and to promote healthy digital habits. A psychologist and a cyber-safety expert will be invited as speakers, and about 200 students are expected to participate.

For the smooth conduct of the program, we kindly request the following support:

1. The seminar hall with 200 chairs and a stage
2. A projector, a sound system and a microphone
3. Permission to use the college notice board and print banners/posters
4. Refreshments for the guests and a small budget of Rs 10,000
5. A teacher as a coordinator and the release of students for the program

We assure you that the program will be conducted with discipline and care of the college property. We would be grateful if you would grant our request.

Thank you for your kind consideration.

Yours faithfully,

[Signature] [Student Name] Coordinator, Students' Club

MEMO

TO: All Student Council Members FROM: Secretary, Student Council DATE: 2082-06-20 SUBJECT: Decisions of the Student Council meeting held on 2082-06-18

The Student Council met on 2082-06-18 in the Seminar Room with the Chairperson presiding. The following decisions were made:

1. Annual sports week: It will be held from 2082-07-05 to 2082-07-09. The sports committee led by the Vice-Chair will prepare the schedule by 2082-06-28.
2. Budget: Rs 40,000 was approved for the sports week and Rs 15,000 for the freshers' welcome program.
3. Library hours: The Council will request the Principal to extend the library hours until 6 pm during examinations. The Secretary will submit the application by 2082-06-25.
4. Cleanliness campaign: Each class representative will organise a cleaning drive in his or her class every Friday.
5. Next meeting: It will be held on 2082-07-02 at 1:00 pm in the same room.

All members are requested to carry out their assigned duties on time and to report progress at the next meeting. Please contact me if you have any questions.

Sunrise Marg, Kathmandu 15 Kartik 2082

The Hiring Manager Himalayan Digital Solutions Pvt. Ltd. Baneshwor, Kathmandu

Subject: Application for the post of Web Page Designer

Dear Sir or Madam,

I am writing in response to your advertisement in The Kathmandu Post dated 10 Kartik 2082 for the post of Web Page Designer. I hold a Bachelor's degree in Information Technology and I believe my skills match the requirements of the position.

My key skills are:

• Front-end development with HTML5, CSS3, JavaScript and responsive frameworks such as Bootstrap.
• UI/UX design using Figma and Adobe XD, including wireframes and prototypes.
• Image and graphics work in Photoshop and Illustrator.
• Knowledge of SEO, accessibility and cross-browser testing.
• Basic WordPress and Git skills, with good teamwork and the ability to meet deadlines.

During my internship I designed and launched a responsive website for a local school, which increased its online enquiries. I enjoy turning ideas into clean, user-friendly pages.

My resume is enclosed. I would welcome an interview to discuss how I can contribute to your team. Thank you for your time and consideration.

Yours faithfully, Ashish Gautam Phone: 98XXXXXXXX Enclosure: Resume

Good morning, respected teachers and dear friends.

Today I will speak briefly about the impacts of our growing reliance on Artificial Intelligence (AI).

AI has changed our lives for the better. It helps doctors detect diseases early, helps students learn through personalised tools, and helps businesses automate routine work. Voice assistants, translation, navigation and recommendation systems save us time every day.

However, over-reliance has a cost. First, when we let machines think for us, our own creativity, memory and problem-solving skills may weaken. Second, automation threatens jobs in routine work. Third, AI can carry bias, spread misinformation and raise serious privacy concerns. Finally, blind trust in AI outputs can lead to costly mistakes because machines can be wrong.

The answer is balance. We should use AI as a helpful tool, verify its results, protect our data, and keep developing our own skills and judgement. Technology should serve humans, not replace human thinking.

Thank you.

RAMESH SHARMA Lalitpur, Nepal | ramesh.sharma@email.com | 98XXXXXXXX | linkedin.com/in/rameshsharma

Career Objective

Computer Engineer with two years of experience in software development, seeking a challenging role where I can apply my technical and problem-solving skills to build reliable systems.

Professional Experience

Software Engineer, ABC Technologies Pvt. Ltd., Kathmandu (2023 - Present)

• Developed and maintained web applications using Java, Spring Boot and MySQL.
• Designed REST APIs used by mobile and web clients.
• Reduced page load time by 30% through query optimisation.
• Worked in an Agile team using Git and CI/CD pipelines.

Intern Engineer, XYZ Soft, Kathmandu (2022)

• Assisted in testing and debugging an inventory management system.

Education

• B.E. in Computer Engineering, Pulchowk Campus, Tribhuvan University (2018 - 2022)
• +2 Science, Kathmandu Model College (2016 - 2018)

Technical Skills

• Languages: Java, Python, JavaScript, SQL
• Tools: Git, Docker, Linux, Postman
• Concepts: Data structures, OOP, networking, databases

Projects

• Online Library System (final-year project) built with Django and PostgreSQL.

Languages

Nepali (native), English (fluent)

References

Available on request.

(1) Wordy phrases such as "it is difficult to", "due to the fact that" and "quite unique" can be cut, and the typing errors ("an") corrected.

Edited: "It is difficult to estimate a general cost per square foot for this system because each installation is unique and depends on many factors."

(2) "While it is true that" and "it is a fact that" add nothing; "sever" should be "severe" and "manufactures" should be "manufacturers".

Edited: "Although many international electronics manufacturers add Netflix buttons to remote controls for the North American market, Canadian consumers may face severe monthly bandwidth limits."

Both versions keep the original meaning but are shorter and clearer, since they remove redundant phrases, use active and direct wording, and fix spelling errors.

(a) Netiquette

Netiquette (network etiquette) is the set of accepted rules of polite and respectful behaviour when communicating online, in email, chat, forums and social media. Key rules:

• Be polite and respectful; never use abusive or offensive language.
• Do not type in ALL CAPS, which looks like shouting.
• Keep messages short, clear and relevant, with a meaningful subject line.
• Respect privacy and do not forward personal information without permission.
• Check spelling and grammar, and think before posting or replying.
• Respect copyright and do not spread rumours or spam.

(b) Tone in Writing

Tone is the writer's attitude toward the reader and the subject, shown through word choice and style. It can be formal, informal, friendly, persuasive, serious or urgent. Good business writing uses a positive, courteous and "you-oriented" tone, avoids sarcasm and negative wording, and suits the audience and purpose. For example, "We regret that we cannot supply the item" is more courteous than "You failed to order on time". The right tone builds goodwill and helps the message achieve its purpose.

(a) Job Advertisement

VACANCY: SOFTWARE ENGINEER

Nepal Innovate Tech Pvt. Ltd., Kathmandu, a fast-growing software company, invites applications from energetic graduates for the post of Software Engineer (2 positions).

Qualifications

• Bachelor's degree in Computer Science/IT/Engineering from a recognised institute.
• Knowledge of Java or Python, databases and web technologies.
• Good communication and teamwork skills.

We offer

• Competitive salary and performance bonus.
• Training, career growth and a friendly work environment.

Interested candidates should send a resume, a cover letter and copies of certificates to careers@nepalinnovate.com within 15 days of this notice. Only shortlisted candidates will be called for interview.

---

(b) Job Application Letter

Lalitpur, Nepal 20 Kartik 2082

The Human Resource Manager Nepal Innovate Tech Pvt. Ltd. Kathmandu

Subject: Application for the post of Software Engineer

Dear Sir or Madam,

I am writing to apply for the post of Software Engineer advertised in The Kathmandu Post on 18 Kartik 2082. I recently completed my degree at the Institute of Science and Technology, Tribhuvan University, and I am eager to begin my career with your company.

My studies gave me strong skills in Java, Python, SQL and web development. For my final project I built a student management system, working in a team and presenting it to a panel. I also completed an internship where I fixed bugs and wrote tested code. I learn quickly, communicate clearly and take responsibility for my work.

I admire your company's innovative products and would be proud to contribute to them. My resume and certificates are enclosed. I would be grateful for an opportunity to attend an interview.

Yours sincerely, Sita Karki Phone: 98XXXXXXXX Enclosures: Resume, certificates

Why business organizations use social media for advertising

• Wide reach at low cost: Platforms such as Facebook, Instagram, TikTok and YouTube reach millions of people at a fraction of the cost of TV or newspaper ads.
• Targeted audience: Ads can be aimed by age, location, interests and behaviour.
• Two-way communication: Customers can comment, ask questions and give feedback, which builds relationships and trust.
• Brand awareness and engagement: Shares, likes and viral content spread a brand quickly.
• Measurable results: Analytics show views, clicks and sales, so campaigns can be improved.
• Fast and flexible: Offers and news can be posted instantly and changed easily.
• Customer support and sales: Many businesses sell directly through social pages.

Formal Report

REPORT ON THE LAUNCH OF THE "NEPAL EASY SHOP" MOBILE APP

To: Managing Director From: Product Development Team Date: 20 Kartik 2082

1. Introduction This report describes the mobile app recently developed by our organization, its features and its early performance.

2. Description of the App Nepal Easy Shop is an Android and iOS app that lets customers browse products, order online and pay through digital wallets, with delivery tracking.

3. Findings

• The app was developed in four months by a team of six.
• In its first month it received about 5,000 downloads, with an average rating of 4.3 out of 5.
• Users praised the simple design; some reported slow loading on weak networks.

4. Conclusion The app has been well received and has widened our customer base.

5. Recommendations

• Optimise performance for low-bandwidth areas.
• Promote the app through social media campaigns.
• Add Nepali language support and regular updates based on user feedback.

Clarity means writing so that the reader understands exactly what the writer means, at first reading. Vagueness means writing that is unclear, general or open to many interpretations.

Examples

• Vague: "Submit the report soon." Clear: "Submit the report to the Manager by 5 pm on Friday."
• Vague: "The product is very good." Clear: "The product has a 12-month warranty and reduces energy use by 20%."

Both concern how a message is expressed, but clarity achieves communication while vagueness defeats it. Clarity is achieved through short sentences, exact words, active voice and logical order.

Plagiarism is using another person's words, ideas, data or work without giving proper credit and presenting them as one's own. It includes copying text, paraphrasing without citation, submitting someone else's work, and reusing one's own earlier work without acknowledgement. It is an academic and ethical offence and may lead to failure, loss of reputation or legal action.

How it can be avoided

• Use your own words and ideas wherever possible.
• Put copied text in quotation marks and cite the source.
• Acknowledge paraphrased ideas with proper citations (APA, MLA, etc.).
• Keep a list of all sources and give a complete reference list or bibliography.
• Take careful notes that separate your ideas from the source's.
• Plan time properly so you do not copy under pressure.
• Use plagiarism-checking software before submitting.
• Learn the institution's rules on academic honesty.

Conflict arises from differing needs, goals or opinions. Important strategies for resolving it are:

• Avoiding: Withdrawing from the issue, useful only for trivial matters or to cool tempers.
• Accommodating: Giving in to the other party to keep harmony.
• Competing: Insisting on one's own view, suitable in emergencies.
• Compromising: Each side gives up something to reach a middle ground.
• Collaborating (problem solving): Both sides work together to find a solution that meets everyone's needs.

Other helpful steps include active listening, staying calm, focusing on the problem and not the person, and involving a neutral mediator.

Preferred strategy: I prefer collaboration. It addresses the root cause, produces a win-win result, preserves relationships and builds trust, so the solution lasts longer than one reached by force or by one side simply giving in.

Technical writing communicates technical or specialised information clearly to a specific audience. Its major attributes are:

• Clarity: The message is easy to understand with a single meaning.
• Conciseness: Short, direct sentences with no unnecessary words.
• Accuracy: Facts, data and figures are correct and verified.
• Objectivity: It is impersonal and factual, free from personal opinion and emotion.
• Audience orientation: Language and detail suit the reader's knowledge and needs.
• Purpose-driven: It informs, instructs or persuades towards a clear goal.
• Organisation: Logical structure with headings, lists and numbering.
• Use of visuals: Tables, charts and diagrams support the text.
• Formal tone and consistent terminology: Technical terms are used correctly and consistently.
• Documentation: Sources are cited and the format is standard.

Good morning, respected teachers and dear friends.

Today I would like to talk about the difficulties of being both a student and an employee.

Many students in our country work part-time to support their studies or their families. This brings independence and valuable experience, but it also brings real challenges.

First, time management is hard. Classes, assignments, exams and work shifts often clash. Second, tiredness and stress build up, because there is little time for sleep, rest or social life. Third, academic performance may suffer when work leaves less time to study. Fourth, there is often financial pressure, and employers may not be flexible about exam periods.

Even so, these difficulties can be managed. Making a weekly schedule, setting priorities, talking honestly with employers and teachers, and taking care of health can help. Working students also gain discipline, responsibility and practical skills that classrooms alone cannot give.

Balancing both roles is not easy, but with planning and determination it is possible.

Thank you.

Ethical dilemma: A situation in which a person must choose between two or more options, each of which is ethically justifiable or has moral costs, and no choice is clearly right. It involves a conflict between values, such as honesty versus loyalty. Example: an employee discovers that a colleague is bending a company rule to help a sick family member, and must choose between reporting it and protecting a friend.

Ethical lapse: A failure to act ethically, where the person knows the right course but chooses the wrong one. The correct action is clear, but the person acts wrongly through carelessness, selfishness or weakness. Example: knowingly copying a report, taking credit for another's work, or falsifying records.

A dilemma calls for careful thought and judgement, while a lapse calls for accountability and correction.

Intercultural communication is the exchange of information, ideas and meanings between people from different cultural backgrounds, who differ in language, values, beliefs, customs, gestures and ways of thinking. It is common in global business, education and multinational workplaces.

Causes of miscommunication: language barriers, differing non-verbal cues (for example, a gesture polite in one culture may be rude in another), stereotypes, ethnocentrism, different attitudes to time and hierarchy, and different communication styles (direct versus indirect).

How it can be overcome

• Learn about other cultures, their customs and etiquette.
• Avoid stereotypes and judging others by one's own culture.
• Be open-minded, respectful and empathetic.
• Use simple, clear language and avoid slang, idioms and jargon.
• Listen actively and ask for feedback or clarification.
• Be sensitive to body language, eye contact and personal space.
• Be patient, and use translators or interpreters where needed.
• Attend cultural awareness training.

Etiquette

Etiquette is the set of accepted rules of polite and proper behaviour in social and professional situations. In the workplace it includes punctuality, respectful greetings, courteous language, appropriate dress, good telephone and email manners, respect for others' time and privacy, and good table manners at business meals. Good etiquette creates a positive image, builds relationships and trust, and helps teamwork and professional success.

Resume

A resume is a short, well-organised document that summarises a person's education, skills, work experience and achievements, used to apply for a job. Its usual parts are:

• Contact information
• Career objective or summary
• Education
• Work experience
• Skills
• Achievements, projects and activities
• References

A good resume is clear, accurate, error-free, tailored to the job and usually one to two pages. Common types are chronological, functional and combined.