Research Software Support
Modules AboutContributeWorkshopsYellow Pages
GitHub LogoOrganization Logo

Software Documentation

Learning objectives
Documentation
Types of documentation
Levels of documentation
Suitable documentation
Further reading

Reusability requires good documentation

  • https://book.the-turing-way.org/reproducible-research/code-reuse/code-reuse-overview

README

The README file is usually the first thing users/collaborators see when visiting your GitHub repository. Use it to communicate important information about your project! For many smaller or mid-size projects, this is enough documentation.

  • https://makeareadme.com>
  • https://gist.github.com/jxson/1784669

Popular tools foor building more complex documentation

  • https://coderefinery.github.io/documentation/tools
These materials are developed by the Netherlands eScience Center. Licensed under CC-BY 4.0 unless otherwise noted.