technical writing | Just Write Click

November 4, 2005 by annegentle

Darwin Information Typing Architecture – DITA (dih tuh)

Roundup of the DITA reading I’ve been diving back in to lately Here’s a rough grouping of some interesting articles I’ve been reading about DITA implementations lately. BMC has explored DITA implementations for both mainframe and distributed documentation, modeling the information for a couple of books. I’ve been looking at DITA case studies this week. […]

October 25, 2005 by annegentle

Getting BMC parameter information that you can manipulate

There’s a tool called the Parameter Reference Database on our support site that lets you export the PATROL Knowledge Module parameters to a CSV file so you can re-mix them as you want. This Parameter Reference Database tool for exporting the KM parameters looks really cool to me so I wanted to be sure you […]

October 24, 2005 by annegentle

Best practices in technical documentation

If you’re in Austin, you’re welcome to attend the Society for Technical Communication meeting where I’ll be moderating a discussion about best practices for documentation. I’ll be moderating a discussion Tuesday night at one of our Society for Technical Communication chapter meetings. I found this article, “Tech writers as sales reps? Interface Software’s award-winning docs […]

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