‘called on’ during the workshop Blue/Teal: I would prefer not to be asked to read out loud Red/Gold: I will be able to focus better today if I can be on my laptop/phone during this workshop don’t judge me Everything Else: I just like beads GET COMFORTABLE, GRAB BEADS, GRAB PAPER, MEET PEOPLE, CHECK EMAIL, WHATEVER WORKS!
and other supporting documents to communicate complex and technical information more easily. They also develop, gather, and disseminate technical information through an organization’s communications channels.
product you work on (professionally or for fun) ▸ In the top right corner, write you initials and a favorite word RRGDingus ▸ Write (legibly) a one to two sentence description of the product I work on the Splice Sounds Library This product lets you purchase royalty free samples. We integrate directly with Ableton, Garageband, etc so you can drag and drop samples and loops you’ve purchased directly into your DAW. ▸ Write the first four steps someone would take to start using the product 1. Sign up for a trial account 2. Download the desktop application 3. Browse sounds on the app or website 4. Download sounds to be automatically downloaded by the desktop app WHAT YOU’LL DO
Reading in the Brain: The New Science of How We Read ▸ Only the center of the retina, called the fovea, has a fine enough resolution to allow for the recognition of small print. Each of them[words] is then split up into myriad fragments by retinal neurons and must be put back together before it can be recognized. ▸ Two major parallel processing routes eventually come into play: the phonological route, which converts letters into speech sounds, and the lexical route, which gives access to a mental dictionary of word meanings. ▸ Your eyes scan the page in short spasmodic movements. Four or five times per second, your gaze stops just long enough to recognize one or two words.
these single little messages that are no heavier than a river pebble. But it doesn't take long until you have acquired a pile of pebbles that's taller than you and heavier than you could ever hope to move, even if you wanted to do it over a few dozen trips. But for the person who took the time to hand you their pebble, it seems outrageous that you can't handle that one tiny thing.
right HJWpalindrome Random summary statement about a product 1. Step one 2. Step two 3. Overly complex step three 4. Step five, for some reason LET’S DO THIS TOGETHER ▸ Get a new piece of paper HJWpalindrome ▸ Copy the “uuid” in the top right ▸ Read the paper you received ▸ Pass the old paper up to the front, keep your copy ▸ You have three minutes to write as much as you remember Uh this company makes zippers I think?
right HJWpalindrome Random summary statement about a product 1. Step one 2. Step two 3. Overly complex step three 4. Step five, for some reason AND AGAIN! ▸ Get a new piece of paper HJWpalindrome ▸ Copy the “uuid” in the top right ▸ Read the paper you received ▸ Pass the old paper up to the front, keep your copy ▸ You have three minutes to write as much as you remember Uh this company makes zippers I think?
Expressive Discourse ‣ Persuasive Discourse ‣ Referential Discourse Your self published autobiography Possibly also your autobiography A proposal, a cover letter A README, an instruction manual Technical Writing for Software Engineers - Linda Levine Linda H. Peasant Susan B Dunkle
a line or two from your original that didn’t make it to the telephone copies Run those lines through translation party Try running a few random sentences
to a place of work” Depends on: Audience familiarity This product lets you purchase royalty free samples. We integrate directly with Ableton, Garageband, etc so you can drag and drop samples and loops you’ve purchased directly into your DAW. 1. Sign up for a trial account
parenthesis Consider replacing ….drag and drop [..] directly into your digital audio workspace (DAW) ….drag and drop [..] directly into your recording software Put the first instance in italics and define … lets you purchase royalty free samples (individual sounds and loops, that can be used without worrying about copyrights).
purchase royalty free samples. We integrate directly with Ableton, Garageband, etc so you can drag and drop samples and loops you’ve purchased directly into your DAW. YUCK
Read out loud This product lets you purchase buy royalty free samples. We integrate directly with Ableton, Garageband, etc so you can drag and drop samples and loops you’ve purchased directly into your DAW. DOES THIS EVEN MAKE SENSE? Am I repeating myself? We integrate directly with … Our desktop application integrates with most major recording software (Ableton, Garageband, etc), allowing instant access to new samples as you work.
refinement, and environments controlled by rule-based editors, as the most promising” Hamlet, Richard. 'A Disciplined Text Environment.” Apr. 1986 ▸ “documentation must be iterative to serve as systems communications within the development process” ▸ recommendation: “techniques and tools valuable in controlling software development be investigated for improving document preparation”
Write Good: github.com/btford/write-good (CLI TOOL) Proselint: proselint.com/write/ (WEB DEMO) Run them both through some of the linters Go to a job hunting website (I recommend stackoverflow.com/jobs) Find 1 posting that would interest you Find 1 posting that looks like a nightmare
WILL NOT GUARANTEE A GOOD PRODUCT. HOWEVER, A PIECE OF WRITING CAN BE ERROR-FREE AND STILL NOT COMMUNICATE EFFECTIVELY Technical Writing for Software Engineers: Linda Levine, Linda H. Peasant, Susan B Dunkle PERHAPS MORE GRACEFULLY STATED
rrgayhart
62gerente
jcasabona
eitanlees
searls
chrislema
scottboms
myddelton
stephaniewalter
afnizarnur
lara
chrisshort
trishagee
![Technical writers […] prepare instruction manuals, how-to guides, journal articles,](https://files.speakerdeck.com/presentations/ca377f499d8a476fb54e14cc31dff81a/slide_3.jpg){kind=link}
