arrow
Return

Top considerations for creating bioinformatics software documentation

delete2017-01-14
delete34
delete
OA
AI
M
Mehran Karimzadeh
M
Michael M. Hoffman *
DOI:10.1093/bib/bbw134delete
deleteOriginal
deleteShare
deleteSave
View PDF
Abstract

Abstract

En 中文
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.
Keywords:
software
documentation
perspective
AI Summary

AI Summary

Key information extracted from the uploaded paper, including a brief overview, abstract, background, key highlights, visual analysis, and future outlook.

Journal

Briefings in Bioinformatics cover
Briefings in Bioinformatics
IF:
7.7
Papers:
5.6K
Citations:
2.7W

Organization

U
university health network toronto
Scholars:
1.7W
Papers: 1.4W
Citations: 19
U
university of toronto
Scholars:
14.7W
Papers: 12.0W
Citations: 165