Search results

New topic in API course: Following agile scrum with documentation projects

by Tom Johnson on Aug 23, 2019
categories: category-api-doc

I added a new article in my API doc course that expands the notion of docs as code to include not only tools but processes as well. I included an excerpt below and a link to the full article.

Following agile scrum with documentation projects

Just as doc-as-code tools mirror tools used by software implementation teams, work processes that tech writers follow can also mirror processes used by software implementation teams. The most common software development methodology today is probably agile scrum.

Although agile scrum is both loved and hated by engineers, and nearly everyone modifies their implementation of it, this methodology has resonance with engineers because so many engineering groups loosely follow the same agile scrum process. Agile scrum is an extremely common approach within the software development industry. When tech writers adopt a similar methodology, engineers they’re working with better understand the tech writer’s processes and workflows.

At the end of the article, there’s a short survey to gather your thoughts and feedback.

Read the full article: Following agile scrum with documentation projects.

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, plain language, tech comm careers, and more. Check out my API documentation course if you're looking for more info about documenting APIs. Or see my posts on AI and AI course section for more on the latest in AI and tech comm.

If you're a technical writer and want to keep on top of the latest trends in the tech comm, be sure to subscribe to email updates below. You can also learn more about me or contact me. Finally, note that the opinions I express on my blog are my own points of view, not that of my employer.