TECHNICAL AND PROFESSIONAL WRITING Lecture: Introduction, Audience and Purpose, Principles, and Organization of Technical Documents COURSE INTENDED LEARNING OUTCOMES (CILOs) After completing this lesson, learners should be able to: CILO 1: Explain the fundamental principles, concepts, processes, and purposes of technical and professional writing. This means learners should be able to: • define technical and professional writing; • identify its fundamental concepts and characteristics; • explain its major purposes; • describe the technical writing process; and • explain the importance of technical writing in workplace and professional communication. CILO 2: Analyze technical and professional texts based on audience, purpose, organization, clarity, accuracy, tone, style, and ethical communication principles. This means learners should be able to: • identify the intended audience of a document; • determine its purpose and communication context; • evaluate its organization and logical flow; • assess clarity, accuracy, and completeness; • examine tone and writing style; and • recognize ethical issues such as misinformation, plagiarism, bias, and misleading communication. CILO 3: Produce clear, concise, accurate, audience-centered, and well-organized technical and professional documents appropriate to workplace and professional contexts. This means learners should be able to: • plan a technical or professional document; • adapt language and tone to a specific audience; • organize information logically; • use appropriate headings, lists, transitions, tables, and other information-design techniques; • revise and edit documents for clarity and accuracy; and • produce professional documents appropriate to workplace situations. I. INTRODUCTION TO TECHNICAL AND PROFESSIONAL WRITING
What is Technical Writing? Technical writing is a type of communication used to present specialized, scientific, technical, or professional information in a clear and useful manner. Simple Definition Technical writing is the process of communicating specialized information clearly, accurately, and effectively to a specific audience for a specific purpose. Example Suppose a company produces a new printer. A technical writer might create a user manual: How to Operate the Printer 1. Connect the printer to a power source. 2. Press the Power button. 3. Connect the printer to the computer. 4. Select the document to print. 5. Click Print. This is technical writing because the document provides specific, useful instructions. II. WHAT IS PROFESSIONAL WRITING? Professional writing refers to written communication used in workplaces, organizations, businesses, institutions, and professional fields. Examples include: • Business letters • Emails • Reports • Memoranda • Proposals • Project documentation • Policies • Minutes of meetings • Performance reports • Professional correspondence Example Subject: Submission of Monthly Report Please submit the completed monthly report to the Department Office by 5:00 p.m. on Friday. This is professional writing because it communicates information in a workplace context.
III. TECHNICAL WRITING VS. PROFESSIONAL WRITING These terms often overlap. Technical Writing Usually focuses on specialized information, procedures, systems, products, or processes. Examples: • Technical report • Laboratory report • User manual • Troubleshooting guide • Installation instructions Professional Writing Has a broader focus on communication within professional or workplace environments. Examples: • Business email • Memorandum • Proposal • Workplace report • Official correspondence Important: A document can be both technical and professional. For example: An engineer prepares a technical report for a company's management team. It is: • technical because it contains specialized information; • professional because it is used in a workplace. IV. NATURE OF TECHNICAL AND PROFESSIONAL WRITING The nature of technical writing refers to its fundamental characteristics.
1. PURPOSE-DRIVEN Technical writing always has a specific purpose. Ask: Why am I writing this? Examples: To inform: The device has a storage capacity of 512 GB. To instruct: Press the Power button for three seconds. To recommend: The organization should replace the outdated equipment. To document: The incident occurred at 9:30 a.m. on August 26. 2. AUDIENCE-CENTERED Technical writing is written according to the needs and knowledge of the intended reader. Example If you explain Wi-Fi to an IT student: Wi-Fi uses IEEE 802.11 standards for wireless network communication. For a younger student: Wi-Fi allows devices such as phones, tablets, and computers to connect to the internet wirelessly. The topic is the same, but the language changes according to the audience. 3. INFORMATION-CENTERED Technical writing focuses on useful information rather than personal emotions.
Weak: I really love this computer because it is super-fast. Technical: The computer has 16 GB of RAM and a high-performance processor, allowing it to run multiple applications simultaneously. 4. TASK-ORIENTED Many technical documents help readers accomplish a particular task. Examples: • Installing software • Operating equipment • Conducting an experiment • Troubleshooting a device • Completing an application Example: How to Restart the Router 1. Turn off the router. 2. Wait 30 seconds. 3. Turn it on again. 4. Wait until the indicator lights stabilize. 5. EVIDENCE-BASED Technical writing should rely on: • facts • research • data • observations • measurements • reliable sources Weak: This machine is the best one.
Better: The machine can process 500 units per hour, compared with 350 units per hour for the existing machine. The second statement provides evidence. 6. OBJECTIVE Technical writing generally avoids unnecessary personal opinions. Subjective: I think the new system is amazing. Objective: The new system reduced processing time by 20%. The second statement is more appropriate for a technical report. V. PURPOSES OF TECHNICAL WRITING Technical writing can serve several purposes. 1. INFORM To provide factual information. Example: The laboratory contains 20 microscopes and four digital imaging systems. 2. EXPLAIN To help readers understand a concept, system, or process. Example: Photosynthesis is the process by which plants convert light energy into chemical energy.
3. INSTRUCT To tell readers how to perform a task. Example: 1. Open the application. 2. Enter your username. 3. Enter your password. 4. Click Log In. 4. DESCRIBE To explain the features, characteristics, or parts of something. Example: The device consists of a display screen, control panel, processor, and rechargeable battery. 5. ANALYZE To examine information and explain its meaning. Example: Survey results indicate that 75% of employees prefer digital training materials. 6. RECOMMEND To suggest a course of action based on evidence. Example: Based on the maintenance records, the company should replace the equipment within the next six months. 7. DOCUMENT To create a permanent record. Example: Incident Report Date: August 26, 2026 Time: 9:30 a.m. Location: Laboratory
Incident: Equipment malfunction Action Taken: Equipment was removed from service for inspection. 8. PERSUADE To convince readers to support a particular action or recommendation. Example: The organization should adopt the new software because it reduces processing time and improves data security. VI. IMPORTANCE OF TECHNICAL WRITING Technical writing is important because organizations depend on accurate and efficient communication. 1. Improves Communication Clear documentation reduces misunderstanding. Example: Instead of telling employees verbally how to operate a machine, the organization can provide a standardized operating procedure. 2. Increases Efficiency Employees can quickly find the information they need. Example: A troubleshooting guide allows employees to solve common problems without waiting for technical support. 3. Supports Decision-Making Reports provide managers with information for making decisions.
Example: A financial report may help management decide whether to purchase new equipment. 4. Creates Permanent Records Written documentation preserves important information. Examples: • project reports • maintenance records • meeting minutes • incident reports 5. Promotes Consistency Standard procedures help employees perform tasks in the same way. Example: A company SOP can ensure that all employees follow the same safety procedure. 6. Reduces Errors Clear instructions reduce mistakes. VII. TECHNICAL WRITING PROCESS Technical writing follows a systematic process: PLAN → RESEARCH → ORGANIZE → DRAFT → REVISE → EDIT → PROOFREAD → DELIVER STEP 1: PLAN Determine: • audience • purpose • context • scope • deadline • format
Example: Before writing a user manual: Audience: First-time users Purpose: Teach users how to operate the device Medium: PDF Tone: Professional and helpful STEP 2: RESEARCH Gather reliable information. Sources may include: • books • journals • official websites • interviews • surveys • observations • organizational records STEP 3: ORGANIZE Arrange information logically. Example: I. Introduction II. Materials III. Procedure IV. Results V. Conclusion STEP 4: DRAFT Write the first version. Focus on getting the ideas and structure onto the page.
STEP 5: REVISE Revision focuses on content and organization. Ask: • Is the information complete? • Is anything missing? • Is the order logical? • Is anything unnecessary? STEP 6: EDIT Focus on: • grammar • sentence structure • word choice • punctuation • formatting STEP 7: PROOFREAD Look for small errors. Example: ❌ The results was recorded. ✅ The results were recorded. STEP 8: DELIVER The document is published or distributed through an appropriate medium. Examples: • PDF • printed report • email • website • company database
VIII. AUDIENCE, PURPOSE, CONTEXT, AND INFORMATION NEEDS One of the most important principles is: Write for the reader, not simply for yourself. A. AUDIENCE ANALYSIS Audience analysis is the process of identifying and understanding the intended readers. Ask: Who are they? Examples: • students • employees • managers • customers • engineers • technicians What do they already know? Experts need less explanation of basic concepts. What do they need? Readers need information that helps them achieve their purpose. B. PRIMARY AND SECONDARY AUDIENCE Primary Audience The main intended readers. Example: A software user manual's primary audience is software users.
Secondary Audience Other people who may read the document. Example: A software manual may also be read by technical support staff. C. EXPERT VS. NON-EXPERT AUDIENCE Expert: The system utilizes a REST API for client-server communication. Non-expert: The API allows different software programs to communicate with each other. The second version explains the technical concept instead of assuming specialized knowledge. IX. PURPOSE Purpose answers: Why is this document being written? Examples: Purpose Example Inform Provide information about a product Explain Explain how a system works Instruct Explain how to perform a task Analyze Interpret research findings Recommend Suggest a solution Document Create an official record Persuade Convince readers to accept a proposal X. CONTEXT Context refers to the circumstances surrounding communication. It includes: • workplace • audience
• purpose • medium • urgency • organizational culture • level of formality Example Casual: Can you send me the report later? Professional: Please submit the completed report by 3:00 p.m. today. The second is more appropriate for a formal workplace situation. XI. USER INFORMATION NEEDS A technical writer must determine what information the user actually needs. Example: Printer Manual Users may need: • setup instructions • printing instructions • paper requirements • ink replacement instructions • troubleshooting information • safety warnings A manual that only describes the printer but does not explain how to use it does not fully meet the user's information needs. XII. TONE Tone is the attitude expressed through writing. Technical writing usually uses a: • professional tone • neutral tone • respectful tone • direct tone
• objective tone Informal: Just click this thing and you're done. Professional: Click the Submit button to complete the process. XIII. LEVEL OF TECHNICALITY Technicality refers to the amount of specialized terminology used. Expert audience: The system uses a TCP/IP-based communication protocol. General audience: The system uses standard internet communication protocols to connect devices. Rule: Use technical terms when they improve precision, but explain unfamiliar terms when necessary. XIV. PRINCIPLES OF EFFECTIVE TECHNICAL WRITING The major principles are: 1. Clarity 2. Conciseness 3. Accuracy 4. Completeness 5. Coherence 6. Consistency 7. Readability 8. Accessibility 9. Professional Tone
1. CLARITY The reader should understand the message easily. Unclear: The machine should be properly handled before operation. Clear: Inspect the machine for visible damage before turning it on. 2. CONCISENESS Use necessary words without unnecessary repetition. Wordy: Due to the fact that the machine is not functioning properly, it is necessary for the operator to conduct an inspection. Concise: Because the machine is malfunctioning, the operator must inspect it. 3. ACCURACY Information must be correct. Example: ❌ Water boils at 50°C at standard atmospheric pressure. ✅ Water boils at approximately 100°C at standard atmospheric pressure. 4. COMPLETENESS Provide enough information for the reader. Incomplete: Install the software.
Complete: Download the installer from the official website. Open the installer and follow the on -screen instructions. Restart the application after installation. 5. COHERENCE Ideas should connect logically. Poor: The company purchased computers. Employees attended training. The computers have 16 GB RAM. Better: The company purchased computers with 16 GB of RAM. To help employees use the new equipment effectively, the company conducted a two-day training session. 6. CONSISTENCY Use the same terminology and formatting. Inconsistent: Click Submit. Later: Click Send. If both refer to the same button, this may confuse the reader. Consistent: Click Submit. Use Submit throughout. 7. READABILITY Make the document easy to read. Use: • short paragraphs • headings • lists
• tables • simple sentence structures • adequate spacing 8. ACCESSIBILITY Make information usable by people with different abilities and needs. Examples: • Use descriptive headings. • Use readable text. • Provide alternative text for meaningful images. • Do not rely only on color to communicate information. • Use descriptive labels. Better: Click Submit Application. Instead of: Click the button above. 9. PROFESSIONAL TONE Avoid: • slang • unnecessary humor • offensive language • excessive emotional language • unsupported claims Informal: This machine is really awesome! Professional: The machine provides higher processing capacity than the previous model.
XV. ORGANIZATION AND DEVELOPMENT OF TECHNICAL DOCUMENTS Good technical writing requires good organization. A basic structure is: INTRODUCTION → BODY → CONCLUSION A more detailed technical report may use: Title → Executive Summary → Introduction → Methods → Results → Discussion → Conclusion → Recommendations → References XVI. OUTLINING An outline is a plan for organizing a document. Example: Topic: Improving Workplace Internet Connectivity I. Introduction • Background • Current problem • Purpose II. Current System • Existing equipment • Internet speed • Problems III. Proposed Solution • New equipment • Cost • Benefits IV. Recommendation • Recommended solution • Justification The outline prevents ideas from being presented randomly.
XVII. PARAGRAPH DEVELOPMENT A strong technical paragraph often contains: Topic Sentence → Supporting Details → Closing/Transition Example: Regular equipment maintenance improves workplace efficiency. Routine inspections allow technicians to identify problems before they become major failures. Preventive maintenance also reduces unexpected downtime and repair costs. Therefore, organizations should establish regular maintenance schedules. XVIII. HEADINGS AND SUBHEADINGS Headings divide information into sections. Example: COMPUTER MAINTENANCE Hardware Maintenance Cleaning the Keyboard Cleaning the Monitor Software Maintenance Updating Applications Removing Unnecessary Files Headings allow readers to scan and locate information quickly. XIX. LISTS Bulleted Lists Use bullets when order is not important.
Example: Required materials: • Laptop • Charger • USB drive • Internet connection Numbered Lists Use numbers when order is important. Example: How to save a document: 1. Click File. 2. Select Save As. 3. Choose the destination folder. 4. Enter the filename. 5. Click Save. XX. TRANSITIONS Transitions connect ideas. Addition • furthermore • moreover • in addition Contrast • however • nevertheless • in contrast Cause and Effect • therefore • consequently • as a result
Sequence • first • next • then • finally Example: First, turn on the device. Next, connect it to the network. Then, open the application. Finally, log in. XXI. LOGICAL SEQUENCING Information should follow an order that makes sense. 1. Chronological Order Based on time. First → Next → Then → Finally Example: First, the sample was collected. Next, it was transported to the laboratory. Finally, it was analyzed. 2. Procedural Order Based on required steps. Example: Step 1 → Step 2 → Step 3 → Step 4 3. General-to-Specific Start with a broad concept and move toward details. Example: Computer System ↓ Hardware and Software ↓ Hardware Components ↓ CPU, RAM, Storage
4. Problem-Solution Example: Problem: Employees experience slow internet. Cause: The current network equipment has limited capacity. Solution: Upgrade the network equipment. Expected Result: Faster and more reliable connectivity. 5. Cause-and-Effect Example: Heavy rainfall caused flooding, resulting in transportation delays. Cause: Heavy rainfall Effect: Flooding and transportation delays 6. Comparison-and-Contrast Example: Feature System A System B Cost Lower Higher Speed Moderate High Capacity Small Large Tables allow readers to compare information efficiently. XXII. INFORMATION DESIGN Information design refers to the way information is organized and visually presented to make it easier to understand. It includes: • headings • lists • tables • diagrams • figures • spacing • typography
• captions Example Instead of writing: The machine has three major components. The first is the control panel. The second is the motor. The third is the power supply. Use: Major Components 1. Control Panel — controls machine operations 2. Motor — provides mechanical movement 3. Power Supply — provides electrical power The second presentation is easier to scan and understand. XXIII. ETHICAL COMMUNICATION IN TECHNICAL WRITING Since CILO 2 includes ethical communication, technical writers must also consider ethics. Ethical technical writing should be: • truthful • fair • responsible • transparent • respectful • properly sourced 1. DO NOT FABRICATE INFORMATION Do not invent data or results. Unethical: The study showed that 95% of employees were satisfied. If no such data were collected, the statement is misleading.
2. DO NOT PLAGIARIZE Plagiarism means presenting someone else's words, ideas, or work as your own without proper acknowledgment. Example: Copying a paragraph from a website and submitting it as your own work without citation is plagiarism. 3. DO NOT MISLEAD THE AUDIENCE Do not deliberately hide important information. Example: If a product has a known limitation, a technical document should not falsely imply that the product has no limitations. 4. PRESENT DATA HONESTLY Do not manipulate data to create a misleading conclusion. Example: If a survey has only 10 respondents, the writer should not present the result as if it represents an entire population without appropriate qualification. XXIV. COMPLETE EXAMPLE Scenario A company wants employees to learn how to use a new online attendance system. Audience Employees with basic computer knowledge. Purpose To instruct employees on how to record attendance.
Context Workplace. Information Needs Employees need to know: • how to log in • how to record attendance • how to correct an error • whom to contact for technical problems Tone Professional and helpful. Organization Online Attendance System 1. Logging In Enter your employee ID and password. 2. Recording Attendance 1. Open the attendance system. 2. Enter your employee ID. 3. Click Time In. 4. Confirm the displayed time. 3. Correcting an Error Contact the HR Office if the recorded time is incorrect. 4. Technical Support For system-related problems, contact the IT Help Desk. Why is this effective? It demonstrates: • audience awareness • clear purpose • appropriate context • user-centered information
• clear organization • concise language • professional tone • logical sequencing XXV. CILO-BASED SUMMARY CILO 1: EXPLAIN You should be able to explain: What is technical writing? → Communication of specialized information. What is professional writing? → Communication used in professional and workplace contexts. What are its purposes? → Inform, explain, instruct, describe, analyze, recommend, document, persuade. What is its process? → Plan → Research → Organize → Draft → Revise → Edit → Proofread → Deliver. CILO 2: ANALYZE When analyzing a technical document, check: AUDIENCE Who will read it? PURPOSE Why was it written? ORGANIZATION Are ideas logically arranged?
CLARITY Is it easy to understand? ACCURACY Is the information correct? TONE Is the attitude appropriate? STYLE Is the language appropriate for the audience and context? ETHICS Is the information truthful, fair, properly sourced, and responsible? CILO 3: PRODUCE When creating your own technical document, remember: Audience → Purpose → Context → Information Needs → Organization → Drafting → Revision → Final Document Your final document should be: Clear Concise Accurate Complete Coherent Consistent Readable Accessible Professional
XXVI. MASTER REVIEWER TECHNICAL WRITING Specialized information + Specific audience + Specific purpose PROFESSIONAL WRITING Workplace/professional communication + Appropriate audience + Professional context PURPOSES I-E-I-D-A-R-D-P • I — Inform • E — Explain • I — Instruct • D — Describe • A — Analyze • R — Recommend • D — Document • P — Persuade WRITING PROCESS P-R-O-D-R-E-P-D Plan Research Organize Draft Revise Edit Proofread Deliver EFFECTIVE WRITING C-C-A-C-C-C-R-A-P Clarity Conciseness Accuracy Completeness Coherence Consistency
Readability Accessibility Professional Tone AUDIENCE ANALYSIS Remember: WHO → WHY → WHAT → HOW WHO = Audience WHY = Purpose WHAT = Information Needs HOW = Organization, tone, technicality, and presentation FINAL KEY IDEA Effective technical and professional writing is reader-centered communication. The writer should not simply ask: “What do I want to say?” Instead, the writer should ask: “Who is my audience, what do they need, what is my purpose, and what is the clearest and most appropriate way to communicate the information?” That mindset connects CILO 1, CILO 2, and CILO 3: first understand technical writing, then analyze how effective documents work, and finally produce clear, accurate, organized, and professional documents.