https://github.com/pkgw/onegoodtutorial
The onegoodtutorial.org website
https://github.com/pkgw/onegoodtutorial
Last synced: 4 months ago
JSON representation
The onegoodtutorial.org website
- Host: GitHub
- URL: https://github.com/pkgw/onegoodtutorial
- Owner: pkgw
- License: cc-by-sa-4.0
- Created: 2025-08-29T14:59:08.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2026-02-12T21:28:40.000Z (4 months ago)
- Last Synced: 2026-02-13T00:55:33.851Z (4 months ago)
- Language: JavaScript
- Size: 725 KB
- Stars: 13
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# One Good Tutorial
This is the repo for [onegoodtutorial.org]!
[onegoodtutorial.org]: https://onegoodtutorial.org/
[**One Good Tutorial**](https://onegoodtutorial.org/) is a resource for people
who are documenting scientific software. The main idea is right there in the
name: the most important thing is that your software’s documentation includes
*one good tutorial*. You need a bit more than that, but not much more: the [One
Good Tutorial software documentation checklist](https://onegoodtutorial.org/)
defines nine core elements of scientific software documentation. The resource
also includes [a playbook](https://onegoodtutorial.org/playbook/) you can follow
to prepare these nine elements with a minimum of angst and a number of
supporting [in-depth guides](https://onegoodtutorial.org/in-depth/).
Visit [onegoodtutorial.org] for all the details. The [About page][about] has
information about the One Good Tutorial project itself.
[about]: https://onegoodtutorial.org/about/
## Legalities
[One Good Tutorial](https://onegoodtutorial.org/) © 2025–2026 by [Peter K. G.
Williams](https://newton.cx/~peter/) is licensed under [CC BY-SA
4.0](https://creativecommons.org/licenses/by-sa/4.0/).
## Acknowledgments
This work was supported by the [Better Scientific Software Fellowship
Program](https://bssw.io/pages/bssw-fellowship-program), a collaborative effort
of the [U.S. Department of Energy (DOE)](https://www.energy.gov/), Office of
Advanced Scientific Computing Research via [ANL](https://www.anl.gov/) under
Contract
[DE-AC02-06CH11357](https://www.usaspending.gov/award/CONT_AWD_DEAC0206CH11357_8900_-NONE-_-NONE-)
and the National Nuclear Security Administration [Advanced Simulation and
Computing Program](https://asc.llnl.gov/) via [LLNL](https://www.llnl.gov/)
under Contract
[DE-AC52-07NA27344](https://www.usaspending.gov/award/CONT_AWD_DEAC5207NA27344_8900_-NONE-_-NONE-);
and by the [National Science Foundation (NSF)](https://www.nsf.gov/) via
[SHI](https://shinstitute.org/) under Grant No.
[2435328](https://www.nsf.gov/awardsearch/show-award?AWD_ID=2435328).