Just Write Click

Technical writing with Continuous Integration and docs-as-code

  • JustWriteClick
  • Contact
  • Books by Anne Gentle
  • Introducing Docs Like Code

February 10, 2012 by annegentle

Open Advice Book Now Available

What we wish we had known when we started working on free open source software (FOSS) – that is the premise of this essay collection, Open Advice. What’s especially interesting to me after having read all 42 essays is there isn’t really a pattern like you’d see when looking at “what I would tell my […]

Filed Under: techpubs, writing Tagged With: advice, book, open source, openstack, writing

January 23, 2012 by annegentle

Pick a beat for release notes

This is fun. Fedora has “beat writers” which harken to journalists tracking a story. Each beat is a section in the release notes. I found it while poking around on the Fedora wiki pages that describe how they do documentation. See fedoraproject.org/wiki/Documentation_Beats. I like this approach for a few reasons. One is that the term […]

Filed Under: techpubs, wiki, writing Tagged With: bestpractices, collaboration, community, documentation

December 2, 2011 by annegentle

From Cement to Spandex – Making PDF and ePub

Which statement is true: “PDFs are like cement.” or “Gentlemen prefer PDF.” Turns out both are true! See my recent OpenStack blog entry, Hacking on Ebooks, for more context and attributions for those statements. We recently held a hackathon which I blogged about earlier to discuss the prep work for creating epub from DocBook XML […]

Filed Under: techpubs, tools, work, writing Tagged With: documentation, ebook, epub, openstack

« Previous Page
Next Page »

More reading

Bubble graph showing sources of developer support data

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

Recently on Just Write Click

  • A Flight of Static Site Generators: Sampling the Best for Documentation
  • Try a GPT about “Docs Like Code” to ask questions
  • Discipline and Diplomacy: Docs in the Open
  • Let’s Find Out: When Do Static Site Generators Do Rendering?
  • GitHub for Managing Tech Docs

Just Write Click in your Inbox

Enter your email address to subscribe to Just Write Click and receive notifications of new posts by email.

Read More

  • Privacy Policy
  • About Anne Gentle, developer experience expert
  • Books by Anne Gentle
    • Conversation and Community
    • Docs Like Code, a Book for Developers and Tech Writers
  • Woman in Tech Speaker Profile
  • Contact

Books

  • JustWriteClick
  • Contact
  • Books by Anne Gentle
  • Introducing Docs Like Code

Copyright © 2025 · WordPress · Log in