Archive for the ‘tools’ 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 »

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 »

From Cement to Spandex – Making PDF and ePub

{ Posted on Dec 02 2011 by annegentle }
No Comments
Tags : , , ,
Categories : techpubs, tools, work, writing
Which statement is true: "PDFs are like cement." or "Gentlemen prefer PDF." Turns out both are true! See my recent OpenStack blog entry, Hacking on Ebooks, for more context and attributions for those statements. We recently held a hackathon which I blogged about earlier to ...Read More »

DocBook, ePub, Hackathon, What More Could You Ask For?

{ Posted on Nov 09 2011 by annegentle }
4 Comments
Tags : , , , , ,
Categories : tools, work, writing
This Friday, on 11/11/11, the Austin Rackspace office is holding a Hackathon. The projects range from "fix the arcade game" to "install notification system to indicate availability of the men's room" to my pet hack project, "create epub output for ...Read More »

Social Support and Documentation Communities

{ Posted on Jul 14 2011 by annegentle }
1 Comment
Tags : , , , ,
Categories : social media, techpubs, tools
Stories of Social Media Sticking in Unlikely Places Saying, "No one reads the manual" just doesn't hold water any more. Social technology has intersected even the classic user manual. There's always someone who will read a book. But their true motivation ...Read More »

Observations from the Open Help Conference

{ Posted on Jun 09 2011 by annegentle }
5 Comments
Tags : , , , , , ,
Categories : techpubs, tools, wiki, work, writing
I attended the Open Help Conference in lush, green, over-20-inches-of-rain Cincinnati over the weekend and learned so much. I wanted to share my observations in a longer format than the 140 characters I used sporadically during the conference. First of all, ...Read More »

Crowdsourcing Inquisition

{ Posted on May 17 2011 by annegentle }
2 Comments
Tags : , , , , ,
Categories : techpubs, tools, writing
I consider myself a curious person. I was constantly questioning as a kid, much to the chagrin of my fifth grade teacher. I recall that he wrote in my yearbook, "Keep asking questions, but when you ask, listen and learn." ...Read More »
« Older Entries