technical writing | Just Write Click

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

January 31, 2006 by annegentle

Product documentation can make a difference

In reading this article that compares Solaris to Linux, something caught my eye about the product documentation Yes, the quality of the documentation will be noticed when it stands above the crowd, and people will compare technical docs product to product. This article titled Solaris Review: Solaris Welcome Home! by Brandon Werner that I found […]

January 27, 2006 by annegentle

Moving from Books to Topic-oriented Writing

A report from JoAnn Hackos’ talk at the Central Texas DITA Users Group meeting January 2006 JoAnn Hackos is well known in the technical writing community and is a member of the DITA Technical Committee. Recently she wrote the article asking, Is DITA Going to Tip? which explores Darwin Information Typing Architecture (DITA) in the […]

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