0
Writing TechnicallyMuhammad Hassan NasrTeam LeaderBadrIT
Technical Writing
What is it anyway?
Its About Technical  communication.
Why Technical Writing?
First Thing:Its how you look to others
Clients, Manager,  Professor, ...
They rarely see your code     or work details
But
They do read your mails,...
Documentation
Presentations,Reports, API Docs, ...
Installation Guide,User Guide, Help, etc.
Second Thing:It isnt how good you          are...
Its how you arecommunicating your     good work !
Third Thing:Your work will be useless ifothers cant understand you
First Impressions Last
So, How to be a good  technical writer?
And even a goodcommunicator...
Three Cs
Clear
Know your audience
Talk their language
Use jargon they know
Define the unfamiliar
The weather was of anextreme nature on the     west coast.  Can we rewrite the above?
California had very cold  weather last week.
Concise
Keep it Simple, Stupid        (KISS)
Less is More
That is something with which I cannot agree.  Can we rewrite the above?
That is something I cannot        agree with.
Complete
Say what you should and       no more.
Give references,  wiki links, ...
OK, lets learn how to write..
Writing is layout + letters
Lets look at the layout.
Technical Writing is  Presentational
Attractive Layout
Top Down Strategy
Headings
Chunks"Short Paragraphs"
Use Images
A picture is worth a thousand words
Use examples
Examples eliminate misconceptions
Now lets play with the        letters
Start with capital
End with a period   .
Other examples of period
Dr. Bauer      M.S. degree  Steven S. Wilson Jr.(Time is now 4:30 p.m.)        (10 B.C.)
Use commas, semicolonand other punctuations.
after the show ended.    we had coffee What is wrong with the above?
After the show ended, we        had coffee.
You will need to do more homework; for exampleread rules here and here
This is an example ofcolon:● Some bullets.● It can be followed a  numbered.● Or alpha list as well.
Bullets and numbered listmake your info clear and       absorbable.
Whats wrong with this?
Use only 1 space between          words
"Dont forget to useQuotations", Muhammad     Hassan said.
Use parentheses to make it   more clear (this is a   recursive example).
Apostrophe have its rules     isnt that true?
Hyphen is a bit-trickyUse spell-checker or google to validate
Why i use JAVA to access          api?.     Whats wrong with the above?
Why i use JAVA to access          api?.
The pronoun i cant ever       be small.
All capital letters means   Abbreviation (API)             or       SHOUTING
No capitals in the middle.
Except for...
● Titles: Writing Technically● Knowns: Thursday, Sun,  Alex, East ...● Proper Nouns: Testing Team● Names: Muhammad Hassan
More rules here
One last thing ...
Writing Process
Similar to software process
Prewriting
Drafting
Revising
Structure, Spell and  grammar check
Read it through the eye of     your audience
Editing
Lets recap
Others see you through     your writings
ClearConciseComplete
Writing = layout + letters
Writing Process
Homework
Employee:Complete learning
Management:Update Evaluation    Process
References●   Wikipedia●   Sentence Structure of Technical Writing●   Writing Process●   Top 10 rules of punctuation.●   E...
To be a good writer, read   a lot of good text.        Thanks
Upcoming SlideShare
Loading in...5
×

Writing technically

2,245

Published on

Published in: Business, Education
0 Comments
1 Like
Statistics
Notes
  • Be the first to comment

No Downloads
Views
Total Views
2,245
On Slideshare
0
From Embeds
0
Number of Embeds
14
Actions
Shares
0
Downloads
24
Comments
0
Likes
1
Embeds 0
No embeds

No notes for slide

Transcript of "Writing technically"

  1. 1. Writing TechnicallyMuhammad Hassan NasrTeam LeaderBadrIT
  2. 2. Technical Writing
  3. 3. What is it anyway?
  4. 4. Its About Technical communication.
  5. 5. Why Technical Writing?
  6. 6. First Thing:Its how you look to others
  7. 7. Clients, Manager, Professor, ...
  8. 8. They rarely see your code or work details
  9. 9. But
  10. 10. They do read your mails,...
  11. 11. Documentation
  12. 12. Presentations,Reports, API Docs, ...
  13. 13. Installation Guide,User Guide, Help, etc.
  14. 14. Second Thing:It isnt how good you are...
  15. 15. Its how you arecommunicating your good work !
  16. 16. Third Thing:Your work will be useless ifothers cant understand you
  17. 17. First Impressions Last
  18. 18. So, How to be a good technical writer?
  19. 19. And even a goodcommunicator...
  20. 20. Three Cs
  21. 21. Clear
  22. 22. Know your audience
  23. 23. Talk their language
  24. 24. Use jargon they know
  25. 25. Define the unfamiliar
  26. 26. The weather was of anextreme nature on the west coast. Can we rewrite the above?
  27. 27. California had very cold weather last week.
  28. 28. Concise
  29. 29. Keep it Simple, Stupid (KISS)
  30. 30. Less is More
  31. 31. That is something with which I cannot agree. Can we rewrite the above?
  32. 32. That is something I cannot agree with.
  33. 33. Complete
  34. 34. Say what you should and no more.
  35. 35. Give references, wiki links, ...
  36. 36. OK, lets learn how to write..
  37. 37. Writing is layout + letters
  38. 38. Lets look at the layout.
  39. 39. Technical Writing is Presentational
  40. 40. Attractive Layout
  41. 41. Top Down Strategy
  42. 42. Headings
  43. 43. Chunks"Short Paragraphs"
  44. 44. Use Images
  45. 45. A picture is worth a thousand words
  46. 46. Use examples
  47. 47. Examples eliminate misconceptions
  48. 48. Now lets play with the letters
  49. 49. Start with capital
  50. 50. End with a period .
  51. 51. Other examples of period
  52. 52. Dr. Bauer M.S. degree Steven S. Wilson Jr.(Time is now 4:30 p.m.) (10 B.C.)
  53. 53. Use commas, semicolonand other punctuations.
  54. 54. after the show ended. we had coffee What is wrong with the above?
  55. 55. After the show ended, we had coffee.
  56. 56. You will need to do more homework; for exampleread rules here and here
  57. 57. This is an example ofcolon:● Some bullets.● It can be followed a numbered.● Or alpha list as well.
  58. 58. Bullets and numbered listmake your info clear and absorbable.
  59. 59. Whats wrong with this?
  60. 60. Use only 1 space between words
  61. 61. "Dont forget to useQuotations", Muhammad Hassan said.
  62. 62. Use parentheses to make it more clear (this is a recursive example).
  63. 63. Apostrophe have its rules isnt that true?
  64. 64. Hyphen is a bit-trickyUse spell-checker or google to validate
  65. 65. Why i use JAVA to access api?. Whats wrong with the above?
  66. 66. Why i use JAVA to access api?.
  67. 67. The pronoun i cant ever be small.
  68. 68. All capital letters means Abbreviation (API) or SHOUTING
  69. 69. No capitals in the middle.
  70. 70. Except for...
  71. 71. ● Titles: Writing Technically● Knowns: Thursday, Sun, Alex, East ...● Proper Nouns: Testing Team● Names: Muhammad Hassan
  72. 72. More rules here
  73. 73. One last thing ...
  74. 74. Writing Process
  75. 75. Similar to software process
  76. 76. Prewriting
  77. 77. Drafting
  78. 78. Revising
  79. 79. Structure, Spell and grammar check
  80. 80. Read it through the eye of your audience
  81. 81. Editing
  82. 82. Lets recap
  83. 83. Others see you through your writings
  84. 84. ClearConciseComplete
  85. 85. Writing = layout + letters
  86. 86. Writing Process
  87. 87. Homework
  88. 88. Employee:Complete learning
  89. 89. Management:Update Evaluation Process
  90. 90. References● Wikipedia● Sentence Structure of Technical Writing● Writing Process● Top 10 rules of punctuation.● Effective Writing● Capitalization Rules● Punctuation Rules
  91. 91. To be a good writer, read a lot of good text. Thanks
  1. A particular slide catching your eye?

    Clipping is a handy way to collect important slides you want to go back to later.

×