Abstract
Investing in documenting your bioinformatics software well can increase its impact and save your time. To maximize the effectiveness of your documentation, we suggest following a few guidelines we propose here. We recommend providing multiple avenues for users to use your research software, including a navigable HTML interface with a quick start, useful help messages with detailed explanation and thorough examples for each feature of your software. By following these guidelines, you can assure that your hard work maximally benefits yourself and others.
Funding Information
  • Canadian Cancer Society (703827)
  • Ontario Institute for Cancer Research
  • Natural Sciences and Engineering Research Council of Canada (RGPIN-2015-03948)
  • Ministry of Research, Innovation and Science (ER-15-11-223)
  • University of Toronto McLaughlin Centre (MC-2015-16)
  • Princess Margaret Cancer Foundation (MC-2015-16)