Technical Writing

Course Title: Technical Writing

Course No: BDS255

Nature of the Course: THEORY

Semester: 4

Full Marks: 45 + 30

Pass Marks: 18 + 12

Credit Hours: 3

Course Description

This course introduces students to technical and professional writing. It covers the full development process of technical documentation, including planning, writing, visual design, editing, indexing, and production. Students will gain practical insights into communicating in workplace environments and technical discourse communities, such as those in data analysis and scientific research. Key genres include emails, letters, resumes, memos, reports, proposals, technical descriptions, definitions, and manuals. To align with real-world applications, emphasis is placed on skills beyond writing, such as using structured authoring tools like XML and DITA (Darwin Information Typing Architecture) for streamlined content development, and leveraging Web 2.0 technologies (e.g., blogs, wikis, forums) for collaborative technical communication. This prepares students for creating both printed and online content that is clear, translatable, and adaptable in technical contexts.

Course Objectives

Upon successful completion of the course, students will be able to: • Analyze and respond to rhetorical situations in technical writing, considering audience, organization, visual design, style, and production of documents relevant to technical fields. • Produce professional-quality technical documents, both individually and collaboratively, incorporating planning, editing, and indexing for printed and online formats. • Refine writing style to achieve clarity, concision, coherence, cohesion, and emphasis, while ensuring objectivity and ease of translation. • Apply visual design principles and graphics to enhance document appeal and usability in technical applications like reports and manuals. • Integrate modern tools and standards, such as XML-based structured authoring and DITA, to optimize content development processes. • Utilize Web 2.0 technologies (e.g., blogs, wikis, forums) to facilitate interactive and collaborative technical communication. • Practice native-like pronunciation and oral skills through audio-visual aids, enabling effective presentation of technical ideas.

Course Contents

1. So, What’s a Technical Writer?

6 hrs

1.1. Knowledge of technology

1.2. Ignorance is bliss

1.3. Who treats the doctor and who documents for the writer?

1.4. Writing ability

1.5. Miss Thistlebottom was right

2. The Technical Writing Process

6 hrs

2.1. Overview of the writing process

2.2. Authoring with templates and structure

2.3. Template-based authoring

2.4. Structured authoring

2.5. Benefits for professional well-being

3. Very Necessary Evils—Doc Plans and Outlines

6 hrs

3.1. What’s a doc plan?

3.2. Creating outlines

3.3. Managing scope and timelines

3.4. Involving stakeholders

4. The Tech Writer’s Toolbox

6 hrs

4.1. Content/text development tools for printed content

4.2. Graphics software

4.3. Rich media tools

4.4. Help/web authoring tools

4.5. File conversion utilities

4.6. Other software

4.7. Computers and ergonomics

5. Getting Information

6 hrs

5.1. Technical specifications

5.2. Benefits/drawbacks of specs

5.3. Prototypes/software under development

5.4. Legacy content

6. Visual Communication

6 hrs

6.1. Principles of effective visuals

6.2. Creating charts/diagrams

6.3. Integrating graphics into content

7. Task-Oriented Writing (Procedures)

6 hrs

7.1. Writing procedures/instructions

7.2. User-centered content

7.3. Structuring for usability in step-by-step guides

8. Web 2.0 and Technical Communication

6 hrs

8.1. Impact of blogs/wikis/forums

8.2. Collaborative tools

8.3. Integrating Web 2.0 into workflows

Reference Books

1.Pringle, Alan S., and Sarah S. O'Keefe (2009). Technical Writing 101: A Real-World Guide to Planning and Writing Technical Content. 3rd ed., Scriptorium Publishing
2.Alred, Gerald J., et al (2009). Handbook of Technical Writing. 9th ed., Bedford/St. Martin’s
3.Atkinson, Dawn, and Stacey Corbitt (2021). Mindful Technical Writing: An Introduction to the Fundamentals. Montana Technological University
4.Laplante, Phillip A (2018). Technical Writing: A Practical Guide for Engineers, Scientists, and Nontechnical Professionals. 2nd ed., CRC Press

Notes:

This syllabus follows the official Bachelor in Data Science curriculum of Tribhuvan University. In case of any doubt or revision, the university's published syllabus shall be considered authoritative.

Technical Writing

Technical Writing

Select University

Select Program

TabFlux . Technical Writing . TU . BDS