technical writing | Just Write Click

April 11, 2006 by annegentle

Getting expert content from outside sources

Riffing on some ideas for getting authoritative technical content from new sources What can you do when expert content is hard to come by? I’m talking about the upper-crust trusted sources of technical information, much like how A-list bloggers are set to get the higher page rankings on certain topics. Even Technorati is allowing you […]

March 2, 2006 by annegentle

Our DITA experience at BMC Software

With The Rockley Report now available for free, I can point you to a case study about our use of DITA. DITA stands for Darwin Information Typing Architecture, an XML-based information architecture design originally from IBM but also an OASIS Standard with an open source toolkit on SourceForge also available. This case study outlines our […]

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

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