首页> 美国卫生研究院文献>Briefings in Bioinformatics >Top considerations for creating bioinformatics software documentation
【2h】

Top considerations for creating bioinformatics software documentation

机译:创建生物信息学软件文档的主要注意事项

代理获取
本网站仅为用户提供外文OA文献查询和代理获取服务,本网站没有原文。下单后我们将采用程序或人工为您竭诚获取高质量的原文,但由于OA文献来源多样且变更频繁,仍可能出现获取不到、文献不完整或与标题不符等情况,如果获取不到我们将提供退款服务。请知悉。

摘要

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界面和快速入门,有用的帮助消息(其中包含详细的说明)以及有关软件每个功能的完整示例。通过遵循这些准则,您可以确保自己的辛勤工作最大程度地使您自己和他人受益。

著录项

相似文献

  • 外文文献
  • 中文文献
  • 专利
代理获取

客服邮箱:kefu@zhangqiaokeyan.com

京公网安备:11010802029741号 ICP备案号:京ICP备15016152号-6 六维联合信息科技 (北京) 有限公司©版权所有
  • 客服微信

  • 服务号