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
Descripción
Sumario: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.