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.
%0 Journal Article
%1 karimzadeh2017considerations
%A Karimzadeh, Mehran
%A Hoffman, Michael M
%D 2017
%J Briefings in Bioinformatics
%K diss forschungsdaten recommendation software
%N 4
%P 693-699
%R 10.1093/bib/bbw134
%T Top considerations for creating bioinformatics software documentation
%U https://doi.org/10.1093/bib/bbw134
%V 19
%X 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.
@article{karimzadeh2017considerations,
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.}},
added-at = {2021-06-05T17:44:14.000+0200},
author = {Karimzadeh, Mehran and Hoffman, Michael M},
biburl = {https://puma.ub.uni-stuttgart.de/bibtex/2fb13147c5d49c991179550f33cb3ebde/hermann},
doi = {10.1093/bib/bbw134},
eprint = {https://academic.oup.com/bib/article-pdf/19/4/693/25193101/bbw134.pdf},
interhash = {c7e73a48cc16904acd7afeb243f9bb1f},
intrahash = {fb13147c5d49c991179550f33cb3ebde},
issn = {1477-4054},
journal = {Briefings in Bioinformatics},
keywords = {diss forschungsdaten recommendation software},
month = {01},
number = 4,
pages = {693-699},
timestamp = {2021-06-05T15:44:14.000+0200},
title = {Top considerations for creating bioinformatics software documentation},
url = {https://doi.org/10.1093/bib/bbw134},
volume = 19,
year = 2017
}
