📚 Technical Writing
Complete Study Guide
دليل الدراسة الشامل- الكتابة التقنية
Lecture 1: Introduction to Technical Writing
🔷 What is Technical Writing?
• Writing used to communicate technical and factual information ()معلومات تقنية وواقعية
• Targets specific audiences : technical, managerial ()إدارية, or general
• Aims to : inform, instruct, explain, or describe
🛠️ Where is it Used?
Fields: Appears in:
• Engineering ()هندسة • Emails, memos, letters
• Science • Reports, manuals ()أدلة
• Business • Brochures ()نشرات, web pages
• Medicine • Presentations
• Technology
📚 Historical Evolution( )التطور التاريخي:
• Seen in the works of Leonardo da Vinci, Newton, Hippocrates
Grew during:
○ Industrial Revolution (mechanical tools)
○ World War II (weapons + technology)
○ Computer revolution (manuals, software, digital guides)
📊 Importance in Work:
• Technical writing is critical in careers
• Employers want people who can write and speak clearly
🧾 Time spent writing:
20% 50% 80-100%
Employees Managers CEOs
👥 Types of Readers:
1 Technical Readers – Experts in the subject ()خبراء في الموضوع
2 General Readers – Non-experts (need simplified language) ()غير متخصصين
Lectures 2,3: The Technical Writing Process
🔟 7 Key Steps
1 Think and Prepare
🧾 Set your objective (be specific!) ( ) هدف محدد
👤 Know your audience (technical/managerial/general)
🔍 Define your scope (how deep to go) ( ) نطاق
📚 Do your research (facts, experience, sources)
2 Organize and Develop
Use one of these development methods:
• General ➡️ Specific • Specific ➡️ General
• Chronological ()زمني • Sequential ()تسلسلي
• Cause ➡️ Effect • Comparison ()مقارنة
• Spatial ()مكاني
3 Outline()مخطط
3 formats:
✅ Simple List – Fast, for short messages
🏛 Academic Outline – Roman numerals & letters
🧾 Engineering Outline – Decimal numbers (e.g., 1.1.2)
4 Rough Draft()مسودة أولية
• Write fast without editing 🏃♂️
• Don't stop to fix grammar or typos
• Purpose : get your ideas out!
5 Revision()مراجعة
3 Main Tasks:
1. Activate the Language – Use action verbs
2. Clarify the Writing – Avoid confusion
3. Simplify – Cut unnecessary words
6 Final Draft
Make it professional and attractive:
○ Use white space ○ Add headings and lists
○ Include illustrations ○ Use appendices ()مالحق
7 Final Presentation
• Don't just staple ( )تدبيسyour report!
• Use a cover, binder, or clean layout
• First impressions matter! ✨
Lecture 4: Five Traits of Excellent Technical
Writing
1 Clarity()وضوح
• Use short sentences 🧾 Easy to read
• Use active voice :
✅ "The user pressed the button."
❌ "The button was pressed by the user."
○
⛔ Poor clarity = mistakes, injuries, lawsuits ( )دعاوى قضائية
2 Conciseness()إيجاز
• Be brief and direct
Avoid:
○ Redundancy ("( )تكرارbrand new innovation" ➡️ "innovation")
○ Long words (e.g., "endeavor" ➡️ "try")
○ Prepositional overload ("( )إفراط في حروف الجرat a rapid rate" ➡️ "rapidly")
3 Accessible Design()تصميم سهل الوصول
Make content easy to navigate ( )تصفحusing:
• Headings & subheadings • Bold, italic, underlined text
• White space • Lists (bullets and numbers)
• Tables, graphics • Font variation
📉 Example: turning a big confusing paragraph into a table = huge
improvement!
4 Audience Recognition()إدراك الجمهور
3 Types of Audience:
🧾 High-Tech Peers : Know the field well (use jargon )مصطلحات تقنية
🧾 Low-Tech Peers : Know a little (explain briefly)
👨👩👧 Lay Readers ( )قراء عاديون: Know nothing (avoid jargon, use plain
English)
5 Accuracy()دقة
Grammar ✔️ Data ✔️
Sources ✔️ No emotional manipulation ()تالعب عاطفي
💡 Proofreading Tips ( )نصائح المراجعة:
○ Use spell check ✅
○ Let it sit 📆()اتركه لفترة
○ Peer review 👀 ()مراجعة زمالء
○ Read aloud 📣()اقرأ بصوت عالي
○ Read backwards 🔁 ()اقرأ بالعكس
📚 Technical Writing Study Guide | مرجع دراسة الكتابة التقنية
Good luck with your studies! | !حظًا موفقًا في دراستك Made with Genspark
Business Communication
دليل التواصل التجاري
Letters
الرسائل الرسمية
Letters are formal external communication used in business to connect
with:
Clients Vendors
العمالء الموردين
Government agencies Other professionals
الوكاالت الحكومية المهنيني اآلخر ين
Components of a Letter (8 essentials):
1 Writer's address عنوان الكاتب
2 Date التار يخ
3 Reader's address عنوان المستلم
4 Salutation (Dear…) التحية
5 Main text النص األسايس
6 Complimentary close (Sincerely,…) الخاتمة المهذبة
7 Signature التوقيع
8 Typed name ًا
االسم مطبوع
Keep it short and to the point—usually not more than one page.
Memos
المذكرات الداخلية
Memos are internal communication used within a company.
Key differences from letters:
Memos don't follow the 8-part format.
Use these memo ID lines instead:
Date
To
From (with initials) مع األحرف األوىل
SUBJECT: [TOPIC + FOCUS]
Example:
Subject: VACATION SCHEDULE FOR ACCOUNTANTS
• Topic = Accountants
• Focus = Vacation schedule
Memos should also be clear, concise, well-organized, and focused.
E-mails
الرب يد اإللكرتوني
E-mails can be internal or external and have become the most common
form of business communication.
E-mail Format: Benefits of E-mail:
Date Instant communication
To Can reach multiple people at once
Allows real-time conversation
From
Subject (include topic + focus)
A good e-mail includes:
Strong subject line Clear intro
Informative body Polite conclusion
Part 1: Letters, Memos & E-mails Made with Genspark
Reports & Job Search
التقار ير والبحث عن الوظائف
Reports
التقار ير
Reports come in many types and lengths. They can be short (under 3
pages) or long (over 3 pages).
Common Types of Reports:
Proposals Trip Reports
Suggest solutions to problems Document site visits
اقرتاح حلول للمشاكل توثيق الز يارات الميدانية
Lab Reports Status Reports
Record experiments and results Show project progress
تسجيل التجارب والنتائج إظهار تقدم المرشوع
Structure of Any Report:
1 Identification Lines
(Date, To, From, Subject)
2 Introduction
What and why
3 Body
Details, findings, observations, results
4 Conclusion
Next steps, recommendations, summary
The Job Search Process
عملية البحث عن الوظائف
What it Includes:
Finding job opportunities العثور عىل الفرص الوظيفية
Creating a resumé إنشاء السرية الذاتية
Writing a cover letter or e-mail كتابة رسالة الطلب
Attending an interview حضور المقابلة
Writing a follow-up message كتابة رسالة المتابعة
Resumé Cover Letter
السرية الذاتية رسالة الطلب
A resumé must be: • Goes with the resumé
• Tailored to a specific job
Clear
مخصصة لوظيفة
محددة
Concise • Highlights how you're the best match
Accurate
Structure:
Easy to read
1. Intro:
Should include: What job are you applying for and
• Contact info why?
• Objective
• Education 2. Body:
• Work experience How you match the job requirements
• References
Avoid any false information! 3. Conclusion:
Request for interview or next step
Interview Tips
نصائح المقابلة
Basic Tips: Be prepared to:
Arrive on time • Answer questions like: "Why do you want
this job?"
Dress professionally
• Ask questions about:
Make eye contact - Salary الراتب
Sit/stand properly - Job tasks مهام العمل
Don't chew gum or smoke - Working hours ساعات العمل
Follow-Up Letter/E-mail
رسالة المتابعة
Sent after the interview to:
Thank the interviewer Reconfirm interest Mention anything extra
that shows your value
Keep it short and polite.
Writing Rule Reminder:
5 Traits of Technical Writing
خصائص الكتابة التقنية
Always apply these when writing letters, memos, e-mails, or reports:
1 Clarity 4 Audience Recognition
Clear ideas Write with the reader in mind
2 Conciseness 5 Accuracy
Short words/sentences No grammar or factual errors
3 Document Design
Well-organized, easy to read
Part 2: Reports & Job Search Process
التكتيك األنيق لضمان التقنيات ✨ Made with Genspark
