Learning technical writing

January 13, 2022 · View on GitHub

Just one of the things I'm learning. https://github.com/hchiam/learning

My favourite parts of 2 technical writing courses:

one/summary (click for summary)

  1. one/words#recognize_ambiguous_pronouns

  2. one/clear-sentences#reduce_there_isthere_are

  3. one/short-sentences#reduce_subordinate_clauses_optional

  4. one/paragraphs#answer_what_why_and_how

  5. one/audience#sample_audience_analysis

  6. one/audience#curse_of_knowledge

  7. one/documents#state_your_documents_scope

  8. one/documents#state_your_audience

  9. one/documents#compare_and_contrast

  10. one/documents#write_for_your_audience

  11. one/documents#organize_the_document_to_meet_your_audiences_needs

tech-writing/two (click for summary)

  1. two/editing#come_back_to_it_later

  2. two/editing#change_the_context

  3. two/editing#find_a_peer_editor

  4. two/large-docs#outline_exercise

  5. two: "After you've completed the first draft, check your entire document against the expectations you set in your overview. Does your introduction provide an accurate overview of the topics you cover? You might find it useful to think of this review as a form of documentation quality assurance (QA)."

  6. two/large-docs#disclose_information_progressively

  7. two: "According to research by Sung and Mayer (2012), providing any graphics—good or bad—makes readers like the document more; however, only instructive graphics help readers learn."

  8. two/illustrations#write_the_caption_first

  9. two/illustrations#exercise

  10. two/illustrations#constrain_the_amount_of_information_in_a_single_drawing

  11. two/illustrations#focus_the_readers_attention

  12. two/illustrations#exercise_2

  13. two/sample-code#the_example_and_the_anti-example

  14. two/sample-code#exercise_3