Documentation Playbook Now Available

The Documentation Playbook is a new guide designed to make writing and maintaining documentation for your software projects clearer and easier.

The Documentation Playbook is part of the Playbooks Project from the Open Molecular Software Foundation (OMSF).

What’s inside:

• An overview of the different types of documentation that are useful for open-source scientific software projects
• Writing guidance and templates to help you draft high-quality documentation
• Recommendations for when to work on different parts of your documentation throughout a project’s lifecycle

There is also a companion template repository with ready-to-use templates aligned with the playbook. If your project relies on API calls, the repository is also already set up to use Sphinx’s automatic API documentation tools.

Questions? Reach out to Rachel Clune via email (rachel.clune@omsf.io) or Slack (@rclune).

Want to contribute? The playbooks are open source! You can find the repository here.