1. Writing Technically
Muhammad Hassan Nasr
Team Leader
BadrIT

2. Technical Writing

3. What is it anyway?

4. Its About Technical
communication.

5. Why Technical Writing?

6. First Thing:
Its how you look to others

7. Clients, Manager,
Professor, ...

8. They rarely see your code
or work details

9. But

10. They do read your mails,...

11. Documentation

12. Presentations,
Reports, API Docs, ...

13. Installation Guide,
User Guide, Help, etc.

14. Second Thing:
It isn't how good you
are...

15. It's how you are
communicating your
good work !

16. Third Thing:
Your work will be useless if
others can't understand you

17. First Impressions Last

18. So, How to be a good
technical writer?

19. And even a good
communicator...

20. Three C's

21. Clear

22. Know your audience

23. Talk their language

24. Use jargon they know

25. Define the unfamiliar

26. The weather was of an
extreme nature on the
west coast.
Can we rewrite the above?

27. California had very cold
weather last week.

28. Concise

29. Keep it Simple, Stupid
(KISS)

30. Less is More

31. That is something with
which I cannot agree.
Can we rewrite the above?

32. That is something I cannot
agree with.

33. Complete

34. Say what you should and
no more.

35. Give references,
wiki links, ...

36. OK, lets learn how to write..

37. Writing is layout + letters

38. Let's look at the layout.

39. Technical Writing is
Presentational

40. Attractive Layout

41. Top Down Strategy

42. Headings

43. Chunks
"Short Paragraphs"

44. Use Images

45. A picture is worth a
thousand words

46. Use examples

47. Examples eliminate
misconceptions

48. Now let's play with the
letters

49. Start with capital

50. End with a period .

51. Other examples of period

52. Dr. Bauer
M.S. degree
Steven S. Wilson Jr.
(Time is now 4:30 p.m.)
(10 B.C.)

53. Use commas, semicolon
and other punctuations.

54. after the show ended.
we had coffee
What is wrong with the above?

55. After the show ended, we
had coffee.

56. You will need to do more
homework; for example
read rules here and here

57. This is an example of
colon:
● Some bullets.
● It can be followed a
numbered.
● Or alpha list as well.

58. Bullets and numbered list
make your info clear and
absorbable.

59. What's wrong with this?

60. Use only 1 space between
words

61. "Don't forget to use
Quotations", Muhammad
Hassan said.

62. Use parentheses to make it
more clear (this is a
recursive example).

63. Apostrophe have it's rules
isn't that true?

64. Hyphen is a bit-tricky
Use spell-checker or google to validate

65. Why i use JAVA to access
api?.
What's wrong with the above?

66. Why i use JAVA to access
api?.

67. The pronoun i can't ever
be small.

68. All capital letters means
Abbreviation (API)
or
SHOUTING

69. No capitals in the middle.

70. Except for...

71. ● Titles: Writing Technically
● Knowns: Thursday, Sun,
Alex, East ...
● Proper Nouns: Testing Team
● Names: Muhammad Hassan

72. More rules here

73. One last thing ...

74. Writing Process

75. Similar to software process

76. Prewriting

77. Drafting

78. Revising

79. Structure, Spell and
grammar check

80. Read it through the eye of
your audience

81. Editing

82. Let's recap

83. Others see you through
your writings

84. Clear
Concise
Complete

85. Writing = layout + letters

86. Writing Process

87. Homework

88. Employee:
Complete learning

89. Management:
Update Evaluation
Process

90. References
● Wikipedia
● Sentence Structure of Technical Writing
● Writing Process
● Top 10 rules of punctuation.
● Effective Writing
● Capitalization Rules
● Punctuation Rules

91. To be a good writer, read
a lot of good text.
Thanks