best practices | Just Write Click

July 2, 2007 by annegentle

Writing End-User Documentation in an Agile Development Environment

This article was original published in the June 2007 issue of the CIDM Best Practices Newsletter. It is re-published in its entirety with the permission of the Center for Information Development Management. In this article, we examine an increasingly popular development methodology from the Extreme Programming family—Agile development—and how technical writers can operate successfully in […]

July 19, 2006 by annegentle

Alterpoint blog gives kudos to our Routes to Value approach to BSM and ITIL

Breaking down best practices by making the parts easily accessible Alterpoint is located in Austin (where I’m located) and makes network management software that is integrated with our BMC Remedy Action Request System and BMC now resells their product, DeviceAuthority. With just a couple of “follow this idea” clicks, as often happens when I read […]

February 22, 2006 by annegentle

Best practices in tech comm for fit in the organization

Discussion of where a tech pubs department best fits in a company, and what staffing levels are best suited for success This post is another part in a series about best practices in technical publications for software companies. Other posts include “ Questions for best practices in technical publications” and “Best practices for document management […]

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