Are you setting up documentation for new piece of software? If so, One Good Tutorial aims to help.
✅ Just getting started? Follow the official One Good Tutorial checklist and you can be confident that your docs will emerge in good shape.
📖 Along with the checklist, this site provides guidelines and links to help you set up your docs with a minimum of fuss.
The big idea behind One Good Tutorial is right there in the name. The OGT philosophy says: it would be wonderful if every project could have truly great documentation, but rarely do the stars align to make that possible. Most of us are going to have to start with documentation that’s “good enough”. And what’s good enough? One good tutorial.
One Good Tutorial was developed specifically to support the authors of scientific software, but we hope that it will be helpful to people who work on all kinds of technical projects.
🚧 Work in Progress 🚧
This site is a work in progress! See this blog for a vision of what it’s intended to become.