SciCombinator

Discover the most talked about and latest scientific content & concepts.

Top considerations for creating bioinformatics software documentation

OPEN Briefings in bioinformatics | 16 Jan 2017

M Karimzadeh and MM Hoffman
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.
Tweets*
163
Facebook likes*
3
Reddit*
1
News coverage*
0
Blogs*
0
SC clicks
0
Concepts
Software documentation, Documentation, Technical communication
MeSH headings
-
comments powered by Disqus

* Data courtesy of Altmetric.com