Top considerations for creating bioinformatics software documentation. (14th January 2017)

• Record Type: Journal Article
• Authors: Karimzadeh, Mehran; Hoffman, Michael M
• Is Part Of: Briefings in bioinformatics. Volume 19:Number 4(2018:Jul.)
• Page Start: 693
• Page End: 699
• Publication Date: 2017-01-14
• Subjects: software -- documentation -- perspective; Genetics -- Data processing -- Periodicals; Molecular biology -- Data processing -- Periodicals; Genomes -- Data processing -- Periodicals; 572.80285
• DOI: 10.1093/bib/bbw134
• Languages: English
• ISSNs: 1467-5463

Abstract

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.