4.7 Article

Top considerations for creating bioinformatics software documentation

期刊

BRIEFINGS IN BIOINFORMATICS
卷 19, 期 4, 页码 693-699

出版社

OXFORD UNIV PRESS
DOI: 10.1093/bib/bbw134

关键词

software; documentation; perspective

资金

  1. Canadian Cancer Society [703827]
  2. Ontario Institute for Cancer Research (OICR)
  3. Natural Sciences and Engineering Research Council of Canada [RGPIN-2015-03948]
  4. Ontario Ministry of Research, Innovation and Science [ER-15-11-223]
  5. University of Toronto McLaughlin Centre [MC-2015-16]
  6. Princess Margaret Cancer Foundation

向作者/读者索取更多资源

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.

作者

我是这篇论文的作者
点击您的名字以认领此论文并将其添加到您的个人资料中。

评论

主要评分

4.7
评分不足

次要评分

新颖性
-
重要性
-
科学严谨性
-
评价这篇论文

推荐

暂无数据
暂无数据