Powered by OpenAIRE graph
Found an issue? Give us feedback
image/svg+xml art designer at PLoS, modified by Wikipedia users Nina, Beao, JakobVoss, and AnonMoos Open Access logo, converted into svg, designed by PLoS. This version with transparent background. http://commons.wikimedia.org/wiki/File:Open_Access_logo_PLoS_white.svg art designer at PLoS, modified by Wikipedia users Nina, Beao, JakobVoss, and AnonMoos http://www.plos.org/ ZENODOarrow_drop_down
image/svg+xml art designer at PLoS, modified by Wikipedia users Nina, Beao, JakobVoss, and AnonMoos Open Access logo, converted into svg, designed by PLoS. This version with transparent background. http://commons.wikimedia.org/wiki/File:Open_Access_logo_PLoS_white.svg art designer at PLoS, modified by Wikipedia users Nina, Beao, JakobVoss, and AnonMoos http://www.plos.org/
ZENODO
Other literature type . 2025
Data sources: ZENODO
ZENODO
Presentation . 2025
Data sources: Datacite
ZENODO
Presentation . 2025
Data sources: Datacite
versions View all 2 versions
addClaim

From code to clarity: What makes good docs?

Authors: The Good Docs Project;

From code to clarity: What makes good docs?

Abstract

Talk given to the CASS user/developer experience working group by Alyssa Rock and Carrie Wattula of The Good Docs Project on Sept 2, 2025. Recording available here. Talk 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.

  • BIP!
    Impact byBIP!
    selected citations
    These citations are derived from selected sources.
    This is an alternative to the "Influence" indicator, which also reflects the overall/total impact of an article in the research community at large, based on the underlying citation network (diachronically).
    0
    popularity
    This indicator reflects the "current" impact/attention (the "hype") of an article in the research community at large, based on the underlying citation network.
    Average
    influence
    This indicator reflects the overall/total impact of an article in the research community at large, based on the underlying citation network (diachronically).
    Average
    impulse
    This indicator reflects the initial momentum of an article directly after its publication, based on the underlying citation network.
    Average
Powered by OpenAIRE graph
Found an issue? Give us feedback
selected citations
These citations are derived from selected sources.
This is an alternative to the "Influence" indicator, which also reflects the overall/total impact of an article in the research community at large, based on the underlying citation network (diachronically).
BIP!Citations provided by BIP!
popularity
This indicator reflects the "current" impact/attention (the "hype") of an article in the research community at large, based on the underlying citation network.
BIP!Popularity provided by BIP!
influence
This indicator reflects the overall/total impact of an article in the research community at large, based on the underlying citation network (diachronically).
BIP!Influence provided by BIP!
impulse
This indicator reflects the initial momentum of an article directly after its publication, based on the underlying citation network.
BIP!Impulse provided by BIP!
0
Average
Average
Average
Green