Just Write Click » Technical writing with Continuous Integration and docs-as-code

January 23, 2012 by annegentle

Pick a beat for release notes

This is fun. Fedora has “beat writers” which harken to journalists tracking a story. Each beat is a section in the release notes. I found it while poking around on the Fedora wiki pages that describe how they do documentation. See fedoraproject.org/wiki/Documentation_Beats. I like this approach for a few reasons. One is that the term […]

December 2, 2011 by annegentle

From Cement to Spandex – Making PDF and ePub

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 discuss the prep work for creating epub from DocBook XML […]

« Previous Page

I’ve been thinking a lot about developer support at Cisco recently, especially for the way the world works today with multiple cloud providers. This post is a re-publish of my talk from over five years ago, but the techniques and tools for listening and helping others are still true today. At Rackspace, we watched several […]

Cisco DevNet is our developer program for outreach, education, and tools for developers at Cisco. From the beginning, the team has had a vision for how to run a developer program. Customers are first, and the team implements what Cisco customers need for automation, configuration, and deployment of our various offerings. Plus, the DevNet team […]

I had a great talk with Ellis Pratt of Cherryleaf Technical Writing consulting last week. Here are the show notes, full of links to all the topics we covered. Podcasts are great fun to listen to and participate in, if a bit nerve-wracking to think on your feet and make sure you answer questions succinctly […]

At the beginning of this year, I worked hard to summarize my thoughts on API documentation, continuous publishing, and technical accuracy for developer documentation. The result is an article on InfoQ.com, edited by Deepak Nadig, who also was forward-thinking in having me speak to a few teams at Intuit about API documentation coupled with code. Always […]