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

April 24, 2012 by annegentle

Command line reference with true scrolling

I’m at the OpenStack Design Summit this week, and one of the OpenStack companies here, Piston Computing, created a pen that contains a scroll inside. When you open the scroll, you can see all the commands available for the “nova” client, which is how you send commands to the OpenStack Compute API at the command […]

April 13, 2012 by annegentle

Musings on Collaborative Authoring

I’m reading new thinking from Adam Hyde, FLOSS Manuals founder, in a new book titled “A Webpage is a Book” at http://www.booki.cc/a-webpage-is-a-book/_edit/. I found the gem of a quote above in the section on collaboration. He is re-writing his book about book sprints in this new tome. I knew he had been refining his thinking […]

February 10, 2012 by annegentle

Open Advice Book Now Available

What we wish we had known when we started working on free open source software (FOSS) – that is the premise of this essay collection, Open Advice. What’s especially interesting to me after having read all 42 essays is there isn’t really a pattern like you’d see when looking at “what I would tell my […]

« 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 […]