Archive for the ‘techpubs’ Category:

Documentation as Conversation with CSS

{ Posted on May 22 2013 by annegentle }
5 Comments
Categories : content strategy, techpubs, tools, writing
Three types of speech balloons: speech, thought, scream. I love to explore new ways of conveying technical information, and I'm interested in documentation as conversation. Last year I wanted to convey a "side note" on each page of a Sphinx ...Read More »

Who Wrote OpenStack Grizzly Docs?

{ Posted on Apr 26 2013 by annegentle }
No Comments
Tags :
Categories : techpubs, tools, writing
Sneaking a peek at the numbers for documentation along with the code should show us pointers about docs keeping up with code. As I suspected, there were about three major contributors to the operations manuals that span all the projects, ...Read More »

How It’s Made: the OpenStack API Reference Page

{ Posted on Apr 14 2013 by annegentle }
No Comments
Tags :
Categories : community, techpubs, tools, work, writing
Glad you asked! The site at http://api.openstack.org is a collection of HTML pages, and one page has an especially interesting story about how it is built. The http://api.openstack.org/api-ref.html page provides a listing of all the API calls for all OpenStack ...Read More »

Developers, Writers, and First Jobs

{ Posted on Apr 08 2013 by annegentle }
4 Comments
Tags : , ,
Categories : techpubs, writing
I constantly try to network locally with Austinites, and I'm meeting more tech writers with diverse backgrounds. One of Austin's slogans is "Keep Austin Weird" and while our writers aren't necessarily weird, their backgrounds can be! For example, I know of ...Read More »

Tools and skills in the red

{ Posted on Oct 12 2012 by annegentle }
3 Comments
Tags : , ,
Categories : content strategy, techpubs, work, writing
If this isn't a snapshot of our industry, I don't know what is. A couple of observations: "Documentations" [sic] to me indicates an English-second-language speaker. Members listing that term as a skill is 245K, larger than the 107K "Technical Documentation". Looks like it's ...Read More »

Community Content Strategist

{ Posted on Sep 22 2012 by annegentle }
1 Comment
Tags : , , , ,
Categories : community, techpubs, work, writing
I'm considering a request. It's a request for a new branch in content strategy. Now it's odd to even start such a fork when content strategy itself is so new, so nascent that its molds are barely even formed much ...Read More »

Career Focus: Community Documentation

{ Posted on Sep 13 2012 by annegentle }
No Comments
Tags : , ,
Categories : techpubs, work
I gave this interview via email to Mandy Morgan, a senior at Missouri State University this year, majoring in technical writing with a journalism minor. She wrote up a memo for a career focus class based on the interview and ...Read More »

Open Help Conference 2012 Introduces igor

{ Posted on Aug 12 2012 by annegentle }
1 Comment
Categories : techpubs, tools, writing
I'm at the Open Help Conference in Cincinnati this weekend. Yesterday Florian Nadge from RedHat gave a lovely talk about Writing for Translation. Next up was Warren Block, longtime FreeBSD contributor, Automating Documentation Proofreading What tests of your doc can be automated? ...Read More »

What’s New in Conversation and Community?

{ Posted on Aug 03 2012 by annegentle }
7 Comments
Tags :
Categories : social media, techpubs, tools, wiki, writing
Love this new cover, both photos are Creative Commons licensed once again. Let's look between the covers though! While thinking about the second edition and how three years had passed, I was pleasantly surprised that we could get to the three ...Read More »

Must Read: Confluence, Tech Comm, Chocolate

{ Posted on Apr 26 2012 by annegentle }
5 Comments
Tags : , , , ,
Categories : techpubs, wiki, writing
"Who cares about printing money, let's print chocolate!" --Chapter 23, Driving Wiki Development, Confluence, Tech Comm, Chocolate Do you need proof that Sarah Maddox, author of Confluence, Tech Comm, Chocolate: A wiki as platform extraordinaire for technical communication, is a complete chocolate ...Read More »
« Older Entries