EFFECTIVE TECHNICAL COMMUNICATION
DRAFTING & SAMPLES OF MODULE -1
MODULE 1: INFORMATION DESIGN AND DEVELOPMENT
Different Kinds of Technical Documents
User Manual
Sample
Title: Wi-Fi Router Installation Guide
Purpose: To help users install and configure a Wi-Fi router.
Requirements:
Wi-Fi Router
Power Adapter
Ethernet Cable
Steps:
1. Connect the router to the power supply.
2. Connect the internet cable (WAN port).
3. Turn on the router.
4. Connect your computer or phone to the Wi-Fi network.
5. Open a web browser and enter [Link].
6. Log in using the default username and password.
7. Change the Wi-Fi name (SSID) and password.
8. Save the settings and restart the router.
Result: The router is ready for internet access.
Technical Report
Sample
Title: Server Performance Report
Objective: To evaluate the performance of the college web server.
Observations:
CPU Usage: 45%
RAM Usage: 60%
Disk Space: 80% Available
Network Speed: 100 Mbps
Conclusion: The server is operating efficiently.
Recommendation: Upgrade RAM if usage exceeds 80%.
Standard Operating Procedure (SOP)
Sample
Title: Computer System Startup Procedure
Steps:
1. Check the power supply.
2. Switch on the UPS.
3. Turn on the CPU.
4. Start the monitor.
5. Log in with your username and password.
6. Open the required software.
7. After work, save files and shut down the system.
Installation Guide
Sample
Installing Visual Studio Code
1. Download the installer.
2. Run the setup file.
3. Click Next.
4. Accept the license agreement.
5. Choose the installation folder.
6. Click Install.
7. Launch Visual Studio Code.
Information Development Life Cycle (DLC)
Example: Developing a Software User Manual
Stage Technical Example
Planning Decide to write a user manual for a Student Management System
Analysis Collect software features from developers
Design Prepare document structure and screenshots
Development Write installation and user instructions
Review Test all instructions for accuracy
Publishing Create PDF and upload to the website
Maintenance Update documentation after software upgrades
Organization Structures
Sequential Structure
Sample: Software Installation
1. Download software.
2. Run the installer.
3. Accept the license.
4. Complete installation.
5. Restart the computer.
Hierarchical Structure
Sample: IT Department
IT Director
│
System Administrator
│
Network Engineer
│
Technical Support Engineer
Problem–Solution Structure
Problem: Computer cannot connect to the network.
Cause: Network cable is disconnected.
Solution: Connect the Ethernet cable and restart the network adapter.
Cause-and-Effect Structure
Cause: CPU temperature reaches 90°C.
Effect: The system automatically shuts down to prevent hardware damage.
Factors Affecting Information and Document Design
Audience
Audience Example
Student Simple installation guide
Engineer Hardware configuration manual
Administrator Server maintenance document
Purpose
Purpose Technical Example
Inform Server status report
Explain Network topology
Instruct Software installation guide
Recommend System upgrade proposal
Readability
Poor
Configure the application prior to execution.
Good
Configure the application before running it.
Visual Design
Technical documents should include:
Block diagrams
Flowcharts
Screenshots
Tables
Warning icons
Strategies for Organization
Example: Software Documentation
Introduction
Explains the software purpose.
System Requirements
Lists hardware and software requirements.
Installation
Provides installation steps.
Usage
Explains software features.
Troubleshooting
Lists common errors and solutions.
Information Design for Print Media
Sample
Hardware Maintenance Manual
Tools Required
Screwdriver
Cleaning brush
Compressed air
Procedure
1. Turn off the computer.
2. Disconnect the power cable.
3. Remove the cabinet cover.
4. Clean internal components.
5. Reassemble the system.
Information Design for Online Media
Sample
Cloud Storage Help Page
How to Upload a File
1. Log in to the cloud portal.
2. Click Upload.
3. Select a file.
4. Click Open.
5. Wait for the upload to complete.
6. Verify that the file appears in your account.
Technical Troubleshooting Table
Problem Possible Cause Solution
Computer not
Power cable disconnected Check and reconnect the power cable
starting
No Internet Router is turned off Restart the router
Printer offline USB cable disconnected Reconnect the USB cable
Restart the application and close
Software crash Low memory
unnecessary programs
Too many background
Slow computer Close unused applications
programs
Sample Technical Memo
Title: Network Maintenance Notice
Date: 15 July 2026
Subject: Scheduled Network Maintenance
The campus network will undergo maintenance on 20 July 2026 from 10:00 PM to
12:00 AM. During this period, internet services may be temporarily unavailable. Users
are requested to save their work and log out before the maintenance window.
Sample Technical Proposal
Project: Smart Parking Management System
Objective
Develop an automated parking system using sensors and IoT technology.
Features
Automatic vehicle detection
Real-time parking availability
Mobile application support
Online payment
Benefits
Reduces traffic congestion
Saves drivers' time
Improves parking management
Increases operational efficiency
Technical Exam Example
Question: Explain different kinds of technical documents with suitable examples.
Answer:
Technical documents are specialized documents that communicate technical
information clearly to users, engineers, or managers.
Types of Technical Documents:
1. User Manual – Explains how to operate a product (e.g., Router Installation
Guide).
2. Technical Report – Presents technical findings (e.g., Server Performance
Report).
3. Standard Operating Procedure (SOP) – Provides step-by-step instructions (e.g.,
Computer Startup Procedure).
4. Installation Guide – Explains software or hardware installation (e.g., Visual
Studio Code Installation Guide).
5. Technical Proposal – Suggests a technical solution (e.g., Smart Parking
Management System).
6. Online Help Documentation – Assists users through websites or applications
(e.g., Cloud Storage Help Page).