For AI agents: a documentation index is available at https://idratherbewriting.com/llms.txt. Markdown versions of all pages are available by appending .md to any page URL.

Search results

Finished up the section on documentation processes (for now)

by Tom Johnson on Nov 26, 2020
categories: api-doc • api-doc-site-updates

I finished up the documentation processes section in my API course that I've been adding to over the last couple of months. Here's a list of all the article in this section.

While not comprehensive, these processes elaborate on the original DX content strategy that I originally surfaced. I realize that my perspective on these processes is probably shaped by my current company, experience, tools, product domain, and so on. However, I think these topics cover many aspects common to any documentation group. I’m sure I could add another dozen process topics, as there many facets to managing documentation on a developer portal. This list of 10 articles is a good starting point for thinking about and developing your own documentation processes.

Sponsored

About Tom Johnson

Tom Johnson

I'm an API technical writer based in the Seattle area. On this blog, I write about topics related to technical writing and communication — such as software documentation, API documentation, AI, information architecture, content strategy, writing processes, agent skills, tech comm careers, and more. Check out my AI courses for more on the latest in AI and tech comm. If you're looking for info about documenting APIs, see my API documentation course.

If you're a technical writer and want to keep on top of the latest trends in tech comm, be sure to subscribe to email updates below. You can also learn more about me or contact me.

Finally, I want to note a couple of things. I usually write the first drafts of my posts myself and then use AI to improve accuracy, clarity, and detail in places, so my writing is a mix of human and AI. (Hopefully that's not too off-putting.) Also, the opinions I express on my blog are my own perspectives, not those of my employer.