technical writing | Just Write Click

April 28, 2023 by annegentle

GitHub for Managing Tech Docs

GitHub is a popular platform for software developers to manage their code repositories, collaborate on projects, and track changes over time. However, it is also a powerful tool for technical writers to create and manage documentation. In this blog post, we’ll explore the benefits of using GitHub for technical writing and share some tips for […]

January 1, 2019 by annegentle

Hone your writing skills or specialize? Observations from 2009

Never permit a dichotomy to rule your life, a dichotomy in which you hate what you do so you can have pleasure in your spare time. Look for a situation in which your work will give you as much happiness as your spare time. Pablo Picasso Someone pointed out a bit of a dichotomy in […]

December 10, 2016 by annegentle

Remodeling documentation

An article I wrote on docslikecode.com website: A few years ago we went house-hunting in Austin, Texas. One house was so popular during the first showing, there were six back-to-back appointments. We waited in the driveway while another couple toured it. Once they left, we could quickly go through it while another prospective buyer waited […]

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