Working on Wordsmithing

Working on Wordsmithing

Presented at Write/Speak/Code 2017

2396958133b7324fc7afe505dfa02572?s=128

Ryn Daniels

August 23, 2017
Tweet

Transcript

  1. Working on Wordsmithing Ryn Daniels
 Write/Speak/Code 2017

  2. @rynchantress w/s/c 2017 Ryn Daniels
 they/them - @rynchantress Infrastructure Ops

    Witch, Travis CI
  3. @rynchantress w/s/c 2017 professional writing

  4. @rynchantress w/s/c 2017 professional != formal

  5. Let’s get going.

  6. @rynchantress w/s/c 2017 What do we write?

  7. @rynchantress w/s/c 2017 short long formal informal

  8. @rynchantress w/s/c 2017 short long formal informal Chat Books Conference

    abstracts Talk proposals Resumés Blog posts Pull requests Project proposals Work emails Code reviews Code comments Cover Letters Retrospectives
  9. @rynchantress w/s/c 2017 good writing provides useful, timely information that

    the reader needs.
  10. @rynchantress 3 2 1 w/s/c 2017 agenda PREPARING: IDENTIFYING CONTENT

    WRITING: PROCESS AND STYLE REVIEWING: FEEDBACK AND EDITING
  11. @rynchantress w/s/c 2017 Preparing: 
 identifying content

  12. @rynchantress w/s/c 2017 Content: WHAT are you trying to communicate?

  13. @rynchantress w/s/c 2017 what is the outcome I want from

    the people who read this? Ask yourself:
  14. @rynchantress w/s/c 2017 which people do i want (or need)

    to read this? Ask yourself:
  15. @rynchantress w/s/c 2017 identify your audience

  16. @rynchantress w/s/c 2017

  17. @rynchantress w/s/c 2017

  18. @rynchantress w/s/c 2017 woah that’s a lot of text!

  19. None
  20. @rynchantress w/s/c 2017 Writing: 
 Process and style

  21. @rynchantress w/s/c 2017 start with a summary (or a tl;dr)

  22. None
  23. @rynchantress w/s/c 2017 create an outline

  24. None
  25. None
  26. @rynchantress w/s/c 2017 break content into sections

  27. (pay attention to attention spans)

  28. @rynchantress w/s/c 2017 blargh

  29. None
  30. @rynchantress w/s/c 2017 making information usable

  31. @rynchantress w/s/c 2017 include examples

  32. @rynchantress w/s/c 2017

  33. None
  34. @rynchantress w/s/c 2017 include different levels of content

  35. @rynchantress w/s/c 2017

  36. @rynchantress w/s/c 2017 err on the side of more information

  37. @rynchantress w/s/c 2017 blargh cat tax!

  38. @rynchantress w/s/c 2017 finding your style

  39. @rynchantress w/s/c 2017 Style guides! (not the code kind)

  40. @rynchantress w/s/c 2017

  41. @rynchantress w/s/c 2017 read the backscroll

  42. @rynchantress w/s/c 2017 short long formal informal Chat Books Conference

    abstracts Talk proposals Resumés Blog posts Pull requests Project proposals Work emails Code reviews Code comments Cover Letters Retrospectives
  43. @rynchantress w/s/c 2017 Reviewing:
 Feedback and Editing

  44. @rynchantress w/s/c 2017 blargh

  45. @rynchantress w/s/c 2017 getting feedback

  46. @rynchantress w/s/c 2017

  47. @rynchantress w/s/c 2017 specific feedback groups •Cheerleaders •Critical eyes •Subject

    matter experts •Non-SMEs •Your target audience •Your heroes
  48. @rynchantress w/s/c 2017 blargh don’t read the comments

  49. @rynchantress w/s/c 2017 The editing process

  50. @rynchantress w/s/c 2017 •Write •Read through once (and spellcheck!) •Re-read

    tricky sections •Wait X amount of time •Internal Feedback •External Feedback •Publish/Send! Repeat as needed }
  51. @rynchantress w/s/c 2017 how much is “as needed”?
 How much

    time is “x”?
  52. @rynchantress w/s/c 2017 Value Axis 0 50 100 150 200

    April May June July August September Length/formality of document Time spent
 editing
  53. @rynchantress w/s/c 2017 Length/formality of document Number of cat pictures

    0 50 100 150 200 April May June July August September
  54. @rynchantress w/s/c 2017

  55. @rynchantress w/s/c 2017 don’t let the perfect be the enemy

    of the good.
  56. Cat Tax

  57. @rynchantress w/s/c 2017 tl;dr

  58. @rynchantress w/s/c 2017 •Identify audience and takeaways •Write some words!

    •Ask for and get feedback •iterate (and iterate) and ship •Keep practicing
  59. @rynchantress w/s/c 2017 Thank you!