Larry Hosken: New: Tag: writing

Link: "The Best API Documentation"

A blogger blogs about goals for API Documentation. He starts with the important two questions: …though he doesn't phrase it that way.

Permalink
& Comments

Book Report: A Creator's Guide to Transmedia Storytelling There are plenty of storytellers out there, but they tend to specialize. Meanwhile, these transmedia projects keep popping up: some story-pieces embedded in movies, comics, ARGs, radio plays… ...

Permalink & Comments

FAQs, Facts, Drowning in Questions You're a small team of software developers. You make a service|API|tool|thingy used by many, many software developers. They have questions, so many questions. You're drowning in questions. How can yo...

Permalink & Comments

Book Report: Shady Characters Thursday afternoon, talk at work turned to punctuation. Since work uses a lot of @s and #s, this should not surprise you. Someone hazily remembered that Shakespeare had invented “modern quotati...

Permalink & Comments

Book Report: Confluence, Tech Comm, Chocolate I'm a technical writer. I understand that folks don't always appreciate technical documentation. Sometimes the docs are bad. Sometimes the docs are good…at bearing bad tidings. Tech writer Roz...

Permalink & Comments

Book Report: The Art of Explanation I'm a tech writer. "Professional Ignoramus" would be a more accurate job title, albeit not so likely to land me fun jobs working with clever software developers. Still, it's what I do. Here's what ha...

Permalink & Comments

Link: Audience and Technical Writing E Nashif took some time off from studying to riff about Audience in technical writing. Audience, composition classes, and technical writing Audience, technical writing, ownership, etc (part 2?) O...

Permalink & Comments

Link: Drawing versus Writing Pencils If you doubted my sharp-pencils-aren't-so-great rant, check this out: Drawing versus Writing Pencils. Focus on the user; the ideal pencil sharpness follows the user's intent. ...

Permalink & Comments

not exemplary I laughed at @sec_reactions so much that I decided to make a Tech Writing Reactions tumblr. But then I realized that would take effort, so instead I just captioned one Star Trek photo. ...

Permalink & Comments

Book Report: How to Sharpen Pencils I'm a technical writer. I write instructions. I often team up with a "Subject Matter Expert," someone who's really good at doing something. I ask them what they do and they write it down. You might w...

Permalink & Comments

Scala, part of the new gig Bumped into @kberg and @adamsah yestere'en. We talked about work. They said interesting things which I won't repeat because oh man what if one of them accidentally let slip some confidential informat...

Permalink & Comments

Presentation: Tech Writing for non-Tech Writers I'm a rara avis at Twitter, the only full-time technical writer. As such, my life is that of a celebrity: I'm constantly being invited to events, everybody wants to be seen with me, etc etc. At least...

Permalink & Comments

@ikai pointed out an unintentionally funny article The Real Reason Silicon Valley Coders Write Bad Software. The reason? Because they aren't better English writers. This article made it into the Atla...

Permalink & Comments

Twitter is Hiring a Tech Writer ...or maybe more than one. I dunno, @JoinTheFlock is mysterious to me. I didn't even know the listing was up until someone told me. Am I under a non-solicit thingy with you? I.e., do you work at Goo...

Permalink & Comments

From the list of recent edits to Scala School, a tutorial for the Scala programming language, you might guess that puzzle nerds were trying to sneak in some easter eggs: You'd see a bunch of changes ...

Permalink & Comments

Link: Your free software website I am a technical writer. Within technical writing, as with other kinds of writing, there are genres. Genres are defined by rules. If you want to write the web page for an open-source project, these a...

Permalink & Comments

Puzzle Hunts are Everywhere Is [some of] your team hoping to head to Portland for The WarTron Game? If so, I'd like to tag along as an "embedded reporter". I.e., I'd play the game with y'all and write it up afterwards. Folks ar...

Permalink & Comments

Puzzle Hunts are Everywhere, and worth documenting if you ship them to Seattle or something I'm catching up (caught up now) on Snoutcasts, and just listened to the BANG 28 Debrief. You might wonder: what information was in the BANG 28 puzzle playbook? Folks kept raving about it (and about t...

Permalink & Comments

As a professional technical writer, I am always on the look-out for documentation "success stories." Documentation, when done right, can improve lives. For example, this evening on the bus ride home...

Permalink & Comments

Book Report: The Art of Game Design The Art of Game Design is pretty awesome. This book is about design. In theory, it's about game design. But if you're designing something for humans, this book contains plenty of wisdom. I think thi...

Permalink & Comments

Link: MobNotate The next time someone wants me to mark up their manuscript, I might suggest they use MobNotate to gather feedback. ...

Permalink & Comments

Technical Writing Student Internships Google is taking technical writing interns this summer. Yeah, everyone at Google's a genius and should never ever need anything explained to them. OMG especially not by some wet-behind-the-ears compu...

Permalink & Comments

If you recently guessed SCOUT VAILLANCOURT FOUNTAIN in the 2-Tone Game, try entering SCOUT again. I tried to clarify the wording a bit. If you didn't guess SCOUT VAILLANCOURT FOUNTAIN, then carry on...

Permalink & Comments

"What is a Content Management System?" At the GC Summit, Debbie mentioned that the organizers of the excellent DASH treasure hunt game will start using a content management system to keep track of their puzzles. Someone in the audience a...

Permalink & Comments

Updates:

Tags