Introduction to Technical Writing-Part1
Chapter 1: Introduction
Instructor: Dr. Shanwas Khan
Course Title: Technical Writing of IT Project (IT 7099)
Structure of the Course:
Organized into units (Unit 1, Unit 2, etc.)
Access materials and activities on Moodle under Technical Writing Repository
End of Each Unit Activities:
Tasks and assignments needed to be completed
Multiple choice quizzes assessing knowledge based on video content
Attendance Policy:
Watching videos, completing activities, and passing quizzes count as attendance
Purpose of the Course:
Introduce concepts of technical writing
Focus primarily on writing an academic project report but also provide foundational skills for becoming a professional technical writer
Chapter 2: Be Technical Writing
Definition of Technical Communication:
Communication that occurs in the workplace focused on technical subjects for a specific audience and purpose.
Importance of Effective Technical Communication:
Requires good writing skills and relevant knowledge applicable in both industry and academia.
Learning Outcomes for the Module:
Analyze, design, and plan a project.
Create varied technical documents in line with industry standards.
Chapter 3: Writing Skills
Characteristics of Technical Writing:
Subject is technical, aimed at a specific audience.
Organization is clear and predictable.
Style is concise and tone is objective.
May include visual elements to enhance clarity.
Importance Across Careers:
All professions require technical communication for tasks like writing emails or explaining procedures.
Common Writing Pitfalls:
Ambiguity in writing often suggests unclear thinking, indicating ineffectiveness in communication.
Writing as a Process:
Five key stages in writing:
Research: Understand context and questions (What happened vs. Why).
Plan: Outline your ideas considering audience and purpose.
Draft: Write your thesis with a guiding idea in mind.
Edit: Review and refine written content.
Report: Create final formal report.
Emphasis on critical thinking for effective writing.
Chapter 4: Start The Writing
Primary Sources of Information:
Use original research and primary data.
Secondary Resources:
Include peer-reviewed journals and conference papers.
Key Questions to Address:
Identify your audience’s characteristics and needs.
Determine the project purpose and intended outcomes.
Drafting Tips:
Ensure your thesis guides the drafting process.
Critical Thinking Skills:
Read broadly to understand multiple perspectives.
Make decisions based on reason and evidence.
Question and reflect on beliefs and assumptions.
Chapter 5: Level Of Writing
Performance Expectations:
Level of writing will determine thesis score; aim for critical thinking.
Grading scale indicates varying scores based on writing quality.
Types of Technical Documents:
Range from memos to comprehensive research proposals.
Importance of Audience Awareness:
Identify if writing is for an internal or external audience.
Consider audience’s technical knowledge and interests.
Chapter 6: Write A Thesis
Identifying Purpose:
Define specific outcomes intended from the document.
Consider why information is needed and how it will be used.
Role of Objectives in Writing:
Objectives guide content organization and presentation.
Follow provided templates for consistency in thesis writing.
Example of Prominent Theses:
Claude Shannon’s thesis on Boolean algebra as foundations for computing.
Chapter 7: Conclusion
Highlights of Technical Writing Introduction:
Information about accessing resources and technology
Next session will cover writing thesis title and key characteristics of technical writing.
Quizzes will be based on both parts of the introductory videos.
Accessing the Technical Repository:
Find the thesis template document on Moodle.