Technical Writing - Syllabus

Course Overview and Structure

Embark on a profound academic exploration as you delve into the Technical Writing course () within the distinguished Tribhuvan university's CSIT department. Aligned with the 2074 Syllabus, this course (CSC368) seamlessly merges theoretical frameworks with practical sessions, ensuring a comprehensive understanding of the subject. Rigorous assessment based on a 80 marks system, coupled with a challenging passing threshold of , propels students to strive for excellence, fostering a deeper grasp of the course content.

This 3 credit-hour journey unfolds as a holistic learning experience, bridging theory and application. Beyond theoretical comprehension, students actively engage in practical sessions, acquiring valuable skills for real-world scenarios. Immerse yourself in this well-structured course, where each element, from the course description to interactive sessions, is meticulously crafted to shape a well-rounded and insightful academic experience.


 

Units

Key Topics

  • Introduction to Technical Writing
    WH-1

    Overview of the course and unit, introducing students to the concept of technical writing.

  • You Are a Technical Writer!
    WH-2

    Exploring the role and responsibilities of a technical writer, and how students can identify with this profession.

  • Characteristics of Technical Writing
    WH-3

    Defining the key characteristics that distinguish technical writing from other forms of writing.

  • Technical Writing vs. Other Writing
    WH-4

    Comparing and contrasting technical writing with other types of writing, such as creative writing or journalism.

Key Topics

  • Introduction to Audience and Purpose
    AU-1

    An overview of the importance of understanding audience and purpose in technical writing, and how it sets the foundation for effective communication.

  • Meeting the Audience's Needs
    AU-2

    Understanding the audience's requirements, expectations, and preferences to tailor the content and ensure it meets their needs.

  • Planning Your Document's Purpose
    AU-3

    Defining the purpose of the document, including its goals, objectives, and key takeaways.

  • Defining Document Scope
    AU-4

    Determining the boundaries and limitations of the document to ensure it stays focused and relevant.

  • Selecting the Appropriate Medium
    AU-5

    Choosing the most suitable medium for the document, such as print, digital, or online, based on the audience and purpose.

Key Topics

  • Introduction to Technical Writing
    WR-01

    Overview of the technical writing process and its importance in communication.

  • A Process for Technical Writing
    WR-02

    Understanding the technical writing process as a series of stages.

  • Planning in Technical Writing
    WR-03

    Defining goals, identifying audience, and gathering information for technical writing.

  • Drafting and Revising
    WR-04

    Creating and refining content to effectively communicate technical information.

  • Copyediting and Publishing
    WR-05

    Reviewing and refining content for accuracy and clarity, and preparing for publication.

  • Writing Collaboratively
    WR-06

    Effective strategies for working with others to produce technical writing.

Key Topics

  • History and Background of Artificial Intelligence
    BR-1

    This topic covers the origins and development of Artificial Intelligence as a field of study, including key milestones and contributors.

  • Knowledge Representation
    BR-2

    This topic explores how computers can store, organize, and retrieve knowledge, including data structures and formats used to represent knowledge.

  • Human Information Processing and Problem Solving
    BR-3

    This topic examines how humans process information, reason, and solve problems, including cognitive biases and heuristics.

  • Search
    BR-4

    This topic introduces search algorithms and strategies used in Artificial Intelligence, including uninformed and informed search methods.

  • Expert Systems
    BR-5

    This topic covers the design and development of expert systems, which mimic human expertise in specific domains.

  • Introduction to Neural Networks
    BR-6

    This topic provides a foundational understanding of neural networks, including their structure, function, and applications in Artificial Intelligence.

  • Formatting and Organization
    BR-7

    The principles of formatting and organizing brief correspondence, including headings, paragraphs, and white space. This topic covers how to make your message clear and easy to read.

  • Composing the Message
    BR-8

    The process of writing a clear and concise message, including crafting a strong opening, using active voice, and editing for clarity. This topic covers how to write an effective brief correspondence.

Key Topics

  • Introduction to Document Design
    DO-1

    This topic introduces the importance of document design in technical writing, covering the basics of effective document layout and visual communication.

  • Designing the Document
    DO-2

    This topic explores the principles and best practices of designing a document, including page layout, typography, and white space management.

  • Understanding the Audience for Graphics
    DO-3

    This topic discusses the importance of considering the target audience when creating graphics, including their needs, preferences, and limitations.

  • Designing Effective Graphics
    DO-4

    This topic covers the principles and techniques of designing effective graphics, including visual hierarchy, color, and image selection.

  • Constructing Graphics
    DO-5

    This topic provides guidance on constructing graphics, including choosing the right tools, creating diagrams, and editing images.

Key Topics

  • Introduction to Writing for the Web
    WR-1

    An overview of the importance of writing for the web and the unique considerations involved in this medium. This topic sets the stage for the rest of the unit.

  • Getting Started on Web Pages
    WR-2

    The basics of creating a web page, including planning, structuring, and building a web page from scratch.

  • Organizing and Designing Web Pages
    WR-3

    Principles and best practices for organizing and designing effective web pages, including layout, navigation, and visual design.

  • Writing Text for the Web
    WR-4

    The unique considerations and techniques involved in writing text for the web, including writing style, tone, and format.

  • Special Web Pages
    WR-5

    The unique characteristics and requirements of special types of web pages, such as home pages, landing pages, and FAQs.

Key Topics

  • Introduction to Computers
    IN-01

    An overview of computers and their significance in today's world. This topic sets the stage for understanding the basics of computers.

  • Digital and Analog Computers
    IN-02

    Understanding the difference between digital and analog computers, their characteristics, and applications.

  • Characteristics of Computers
    IN-03

    Exploring the key characteristics of computers, including input, processing, storage, and output.

  • History of Computers
    IN-04

    A brief history of computers, from their inception to the present day, highlighting key milestones and developments.

  • Generations of Computers
    IN-05

    Understanding the different generations of computers, including their features, advantages, and limitations.

  • Classification of Computers
    IN-06

    Categorizing computers based on their size, functionality, and application, including desktops, laptops, and mobile devices.

  • The Computer System
    IN-07

    An in-depth look at the components of a computer system, including hardware and software.

Key Topics

  • Object Oriented Database Concepts
    EM-01

    This topic covers the fundamental concepts of object-oriented databases, including object identity, structure, and type constructors, encapsulation, type and class hierarchies, and inheritance.

  • Object Relational Database Concepts
    EM-02

    This topic explores the integration of object-oriented and relational database concepts, including the SQL standard, object-relational features, and extended type systems.

  • Active Database Concepts
    EM-03

    This topic introduces the concept of active databases, including the generalized model, design and implementation issues, and potential applications.

  • Temporal Database Concepts
    EM-04

    This topic covers the representation and management of time in databases, including time dimensions, tuple versioning, and attribute versioning.

  • Multimedia Databases
    EM-05

    This topic explores the nature of multimedia data and applications, including spatial database concepts and architecture.

  • Deductive Databases and Query Processing
    EM-06

    This topic introduces deductive databases, including Prolog/Datalog notations, clausal form, and horn clauses, as well as query processing techniques.

Key Topics

  • Introduction to Programming Language
    PR-01

    This topic introduces the concept of programming languages, their importance, and brief history. It sets the foundation for understanding the basics of programming.

  • Types of Programming Language
    PR-02

    This topic covers the different types of programming languages, including procedural, object-oriented, functional, and scripting languages. It explains the characteristics and uses of each type.

  • Language Processor
    PR-03

    This topic explains the role of a language processor, including compilers, interpreters, and assemblers. It discusses how they translate source code into machine code.

  • Program Errors
    PR-04

    This topic discusses the different types of program errors, including syntax, runtime, and logical errors. It explains how to identify, debug, and fix errors.

  • Features of Good Program
    PR-05

    This topic outlines the characteristics of a good program, including readability, maintainability, efficiency, and reliability. It provides guidelines for writing good programs.

  • Different Programming Paradigm
    PR-06

    This topic explores different programming paradigms, including procedural, object-oriented, functional, and declarative programming. It explains the principles and applications of each paradigm.

  • Software Development Life Cycle
    PR-07

    This topic covers the stages involved in the software development life cycle, including planning, analysis, design, implementation, testing, and maintenance. It explains the importance of each stage.

  • System Design Tools
    PR-08

    This topic introduces various system design tools, including flowcharts, data flow diagrams, and UML diagrams. It explains how to use these tools to design and develop software systems.

Key Topics

  • Relational Database Design Using ER-to-Relational Mapping
    RE-1

    Learn how to design relational databases using ER-to-relational mapping, including mapping of regular entities, weak entities, relationship types, multivalued attributes, and N-ary relationships.

  • Informal Design Guidelines for Relational Schemas
    RE-2

    Understand informal design guidelines for relational schemas, including semantics of attributes in relations, redundant information in tuples and update anomalies, NULL values in tuples, and generation of spurious tuples.

  • Functional Dependencies
    RE-3

    Study functional dependencies, including definition, inference rules, Armstrong's axioms, attribute closure, equivalence of functional dependencies, and minimal sets of functional dependencies.

  • Normal Forms Based on Primary Keys
    RE-4

    Explore normal forms based on primary keys, including First Normal Form, Second Normal Form, Third Normal Form, and their general definitions.

  • Boyce-Codd Normal Form
    RE-5

    Learn about Boyce-Codd Normal Form, a higher normal form that ensures a relational schema is in a good structure.

Key Topics

  • Introduction to Programming Language
    PR-01

    This topic introduces the concept of programming languages, their importance, and brief history. It sets the foundation for understanding the basics of programming.

  • Types of Programming Language
    PR-02

    This topic covers the different types of programming languages, including procedural, object-oriented, functional, and scripting languages. It explains the characteristics and uses of each type.

  • Language Processor
    PR-03

    This topic explains the role of a language processor, including compilers, interpreters, and assemblers. It discusses how they translate source code into machine code.

  • Program Errors
    PR-04

    This topic discusses the different types of program errors, including syntax, runtime, and logical errors. It explains how to identify, debug, and fix errors.

  • Features of Good Program
    PR-05

    This topic outlines the characteristics of a good program, including readability, maintainability, efficiency, and reliability. It provides guidelines for writing good programs.

Key Topics

  • Software Quality and its Importance
    ET-1

    Understanding the significance of software quality and its impact on software development. This topic covers the importance of quality software and its benefits.

  • Strategies for Developing Quality Software
    ET-2

    Exploring various strategies and approaches to develop high-quality software. This topic covers best practices and techniques for software development.

  • Use of Contingent Workers
    ET-3

    Understanding the role and implications of contingent workers in software development. This topic covers the benefits and drawbacks of using contingent workers.

  • H-IB Workers
    ET-4

    Examining the role and implications of H-IB workers in software development. This topic covers the benefits and drawbacks of using H-IB workers.

  • Outsourcing
    ET-5

    Understanding the concept of outsourcing in software development. This topic covers the benefits and drawbacks of outsourcing and its implications on software development.