Department of Medical Biophysics, University of Toronto, Toronto, Canada.
Brief Bioinform. 2018 Jul 20;19(4):693-699. doi: 10.1093/bib/bbw134.
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.
投入时间做好生物信息学软件文档记录工作可以提高其影响力并节省时间。为了使文档发挥最大效果，我们建议遵循以下我们在此提出的一些准则。我们建议为用户提供多种使用研究软件的途径，包括带有快速入门功能的可导航 HTML 界面、带有详细解释和软件每个功能的透彻示例的有用帮助消息。遵循这些准则可以确保您的辛勤工作能够最大程度地使您自己和他人受益。
