Top considerations for creating bioinformatics software documentation.
Where this comes from
- Record sourced from PubMed, PMID 28088754.
- Also identified by DOI 10.1093/bib/bbw134 and PMC identifier 6054259.
- No licence information is recorded for this record.
- Because redistribution is not established, this page shows the abstract only. Follow the links below for the full text.
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.
Medical subject headings
- Computational Biology
- Documentation
- Guidelines as Topic
- Software