什么样的公司适合用DITA方法写产品文档

作者 | Radu Coravu

- 1 -

哪些公司受益于使用DITA写文档

一般来说,我会将受益于使用DITA满足其技术文档需求的公司分为三大部分:

1. 制造实体产品的公司

这些公司创造现实世界的实物产品,如汽车、冰箱或计算机芯片。每个产品的每个版本都有一个唯一的产品ID,需要记录下来。不同的产品有时在功能上相似,但也有一些差异。

2. 创建版本化软件产品的公司

这些公司提供版本化的软件组件,通常安装在客户端。由于每个客户可能都有旧版本的产品,因此需要提供旧版本的用户手册。

3. 创建无版本软件产品的公司

这些公司通常提供基于云的服务(SaaS),最终用户始终可以访问最新的稳定版本,并且没有为过去的版本提供用户手册。

- 2 -

具体的益处

使用DITA写文档对公司的益处如下:

益处一:利用DITA的重用(reuse)和条件过滤能力,从同一主手册中生成多个类似但不完全相同的手册

公司类型说明
制造实体产品的公司为类似的产品制作手册
创建版本化软件产品的公司为类似类型的软件产品制作用户手册
创建无版本软件产品的公司为类似类型的软件产品制作用户手册

益处二:添加团队所有成员都必须遵循的基于结构的验证规则 - 确保内容一致性

公司类型说明
制造实体产品的公司为整个团队使用通用的验证和术语规则
创建版本化软件产品的公司为整个团队使用通用的验证和术语规则
创建无版本软件产品的公司为整个团队使用通用的验证和术语规则

益处三:创建语义元素的自定义词汇表

公司类型说明
制造实体产品的公司有助于为公司特定的内容添加特定的语义含义
创建版本化软件产品的公司有助于为公司特定的内容添加特定的语义含义
创建无版本软件产品的公司有助于为公司特定的内容添加特定的语义含义

益处四:除了基于网络的输出外,还可以生成对PDF定制具有较高控制程度的PDF

公司类型说明
制造实体产品的公司可用于生成PDF以供打印或在线交付
创建版本化软件产品的公司可用于生成PDF以供打印或在线交付
创建无版本软件产品的公司可用于生成PDF以供打印或在线交付

原文地址:

https://blog.oxygenxml.com/topics/types_of_companies_which_would_benefit_from_the_dita_xml_standard.html

  • 4
    点赞
  • 3
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值