Skip to content

Open Water Foundation / Learn Documenting

This documentation provides resources to learn how to create documentation, in particular for datasets, processes, software, and training materials such as this documentation.

This documentation has been written based on experience in creating documentation at the Open Water Foundation (OWF).

About the Open Water Foundation

The Open Water Foundation is a 501(c)3 nonprofit social enterprise that focuses on developing and supporting open source software for water resources, so that organizations can make better decisions about water. OWF has created this documentation to educate its staff, collaborators, and clients that need to create effective documentation.

See also other OWF learning resources.

How to Use this Documentation

The documentation is organized with general documentation concepts first, followed by a reference of how to create documentation using various technologies.

This documentation is not intended to be a full reference for documentation software tools but focuses on important topics that will help people understand important technical concepts and be successful with documentation tools.

License

The OWF Learn Documenting website content and examples are licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.

Source Repository on GitHub

The source files for this documentation are maintained in a GitHub repository: owf-learn-documenting.

Release Notes

See the Release Notes in the GitHub Project.