Learning technical writing 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) one/words#recognize_ambiguous_pronouns one/clear-sentences#reduce_there_isthere_are one/short-sentences#reduce_subordinate_clauses_optional one/paragraphs#answer_what_why_and_how one/audience#sample_audience_analysis one/audience#curse_of_knowledge one/documents#state_your_documents_scope one/documents#state_your_audience one/documents#compare_and_contrast one/documents#write_for_your_audience one/documents#organize_the_document_to_meet_your_audiences_needs tech-writing/two (click for summary) two/editing#come_back_to_it_later two/editing#change_the_context two/editing#find_a_peer_editor two/large-docs#outline_exercise 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)." two/large-docs#disclose_information_progressively 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." two/illustrations#write_the_caption_first two/illustrations#exercise two/illustrations#constrain_the_amount_of_information_in_a_single_drawing two/illustrations#focus_the_readers_attention two/illustrations#exercise_2 two/sample-code#the_example_and_the_anti-example two/sample-code#exercise_3