Top considerations for creating bioinformatics software documentation
Open Access
- 14 January 2017
- journal article
- research article
- Published by Oxford University Press (OUP) in Briefings in Bioinformatics
- Vol. 19 (4) , 693-699
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.Keywords
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)
This publication has 33 references indexed in Scilit:
- Peering into peer-review at GigaScienceGigaScience, 2013
- Unsupervised pattern discovery in human chromatin structure through genomic segmentationNature Methods, 2012
- Fast gapped-read alignment with Bowtie 2Nature Methods, 2012
- Analysis and design of RNA sequencing experiments for identifying isoform regulationNature Methods, 2010
- Transcript assembly and quantification by RNA-Seq reveals unannotated transcripts and isoform switching during cell differentiationNature Biotechnology, 2010
- BEDTools: a flexible suite of utilities for comparing genomic featuresBioinformatics, 2010
- edgeR: a Bioconductor package for differential expression analysis of digital gene expression dataBioinformatics, 2009
- MEGA: A biologist-centric software for evolutionary analysis of DNA and protein sequencesBriefings in Bioinformatics, 2008
- PLINK: A Tool Set for Whole-Genome Association and Population-Based Linkage AnalysesThe American Journal of Human Genetics, 2007
- SWISS‐MODEL and the Swiss‐Pdb Viewer: An environment for comparative protein modelingElectrophoresis, 1997