Back to Search Start Over

Top considerations for creating bioinformatics software documentation.

Authors :
Karimzadeh, Mehran
Hoffman, Michael M
Source :
Briefings in Bioinformatics; Jul2018, Vol. 19 Issue 4, p693-699, 7p
Publication Year :
2018

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. [ABSTRACT FROM AUTHOR]

Details

Language :
English
ISSN :
14675463
Volume :
19
Issue :
4
Database :
Complementary Index
Journal :
Briefings in Bioinformatics
Publication Type :
Academic Journal
Accession number :
130875347
Full Text :
https://doi.org/10.1093/bib/bbw134