【24h】

Creating a doc spec

机译:创建文档规范

获取原文
获取原文并翻译 | 示例
       

摘要

All technical documentation projects benefit from a good contentnplan or doc spec. The doc spec is a blueprint for a document. Itnidentifies the product, users, source materials, and subject matternexperts (SME). It also provides a preliminary outline of topics, and itnestimates the effort to produce the document. Although the doc specndescribed is for a printed software user guide, you can adapt your docnspec for other types of documentation, including hardware manuals andntraining guides. The doc spec template is simply a tool that leads younthrough the document planning and estimating process. Your customizedndoc spec captures the who, what, when, why, and how of yournproject
机译:所有技术文档项目都将从良好的内容计划或文档规范中受益。该文档规范是文档的蓝图。标识产品,用户,源材料和主题专家(SME)。它还提供了主题的初步概述,并评估了文档制作的工作量。尽管所描述的文档规范是针对印刷软件的用户指南,但是您可以将docnspec修改为其他类型的文档,包括硬件手册和培训指南。文档规范模板只是一个可以引导您完成文档计划和评估过程的工具。您的自定义ndoc规范捕获了您的项目的人员,对象,时间,原因和方式

著录项

相似文献

  • 外文文献
  • 中文文献
  • 专利
获取原文

客服邮箱:kefu@zhangqiaokeyan.com

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

  • 服务号