From Code to Clarity: What Makes Good Docs?

Presentation by Alyssa Rock and Carrie Wattula from The Good Docs Project (https://www.thegooddocsproject.dev/) on Sept 2, 2025 in the Consortium for the Advancement of Scientific Software (CASS; https://cass.community/) User/Developer Experience working group.

Visit the working group website or Slack channel for more: https://cass.community/working-groups...
#wg-udx

Abstract: Effective documentation is crucial for the success of any software project, but it's especially vital in the world of academic and scientific research. In this talk, leaders from The Good Docs Project will explain why documentation matters, including helping users quickly onboard, streamlining troubleshooting efforts, and accelerating problem-solving.

They will then break down the core principles that set truly great documentation apart, including being task-focused, well-structured, and written from the user's point of view. We'll also leave you with some practical strategies for integrating documentation seamlessly into your existing development workflow and processes using the docs-as-code framework. This will empower you and your colleagues to maintain high-quality docs alongside your code, without the extra overhead.

Whether you're new to writing documentation or looking for ways to enhance your existing practices, this talk will empower you to take your software documentation to the next level.