Cargando…

Top considerations for creating bioinformatics software documentation

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, includin...

Descripción completa

Detalles Bibliográficos
Autores principales: Karimzadeh, Mehran, Hoffman, Michael M
Formato: Online Artículo Texto
Lenguaje:English
Publicado: Oxford University Press 2017
Materias:
Acceso en línea:https://www.ncbi.nlm.nih.gov/pmc/articles/PMC6054259/
https://www.ncbi.nlm.nih.gov/pubmed/28088754
http://dx.doi.org/10.1093/bib/bbw134
_version_ 1783340978901352448
author Karimzadeh, Mehran
Hoffman, Michael M
author_facet Karimzadeh, Mehran
Hoffman, Michael M
author_sort Karimzadeh, Mehran
collection PubMed
description 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.
format Online
Article
Text
id pubmed-6054259
institution National Center for Biotechnology Information
language English
publishDate 2017
publisher Oxford University Press
record_format MEDLINE/PubMed
spelling pubmed-60542592018-07-25 Top considerations for creating bioinformatics software documentation Karimzadeh, Mehran Hoffman, Michael M Brief Bioinform Paper 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. Oxford University Press 2017-01-14 /pmc/articles/PMC6054259/ /pubmed/28088754 http://dx.doi.org/10.1093/bib/bbw134 Text en © The Author 2017. Published by Oxford University Press. http://creativecommons.org/licenses/by/4.0/ This is an Open Access article distributed under the terms of the Creative Commons Attribution License (http://creativecommons.org/licenses/by/4.0/), which permits unrestricted reuse, distribution, and reproduction in any medium, provided the original work is properly cited.
spellingShingle Paper
Karimzadeh, Mehran
Hoffman, Michael M
Top considerations for creating bioinformatics software documentation
title Top considerations for creating bioinformatics software documentation
title_full Top considerations for creating bioinformatics software documentation
title_fullStr Top considerations for creating bioinformatics software documentation
title_full_unstemmed Top considerations for creating bioinformatics software documentation
title_short Top considerations for creating bioinformatics software documentation
title_sort top considerations for creating bioinformatics software documentation
topic Paper
url https://www.ncbi.nlm.nih.gov/pmc/articles/PMC6054259/
https://www.ncbi.nlm.nih.gov/pubmed/28088754
http://dx.doi.org/10.1093/bib/bbw134
work_keys_str_mv AT karimzadehmehran topconsiderationsforcreatingbioinformaticssoftwaredocumentation
AT hoffmanmichaelm topconsiderationsforcreatingbioinformaticssoftwaredocumentation