Just Write Click » Technical writing with Continuous Integration and docs-as-code

May 3, 2023 by annegentle

Let’s Find Out: When Do Static Site Generators Do Rendering?

Pre-rendering and progressive rendering are two techniques used by static site generators to improve website performance and user experience. Rendering is generating HTML.

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

April 21, 2023 by annegentle

Power Versus Simplicity With Markdown And Asciidoc

You can use either Markdown or Asciidoc for creating and formatting digital content. While both languages serve a similar purpose, they have distinct differences that suit them for different use cases. Let’s explore the use cases for each markup language so you can make the best choice. Markdown is a simple markup language that is […]

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