怎样让公司全员贡献结构化内容?

文章讲述了DITA作为一种基于XML的文档管理体系,如何通过轻量级DITA(LwDITA)简化,使得非文档工程师如产品工程师、市场营销人员能使用HTML5或Markdown轻松创建内容,同时保持结构化的文档能力。LwDITA减少了元素类型和属性集,支持更广泛的格式,促进了团队协作和内容发布。

- 1 - 

问题

一个朋友在一个生产型企业的文档团队负责产品文档,他们使用DITA来编写各类文档,比如:公司管理文档、产品介绍、产品使用说明、产品安装手册等。

DITA 是基于XML的体系结构,用于编写、制作、交付面向主题的信息类型的内容。DITA的单源内容可以通过不同的方法进行重用,生成不同的交付内容。由于DITA过去用于大型技术手册的编写、管理和交付,它能够满足所有可能呈现给读者的信息发布类型的要求。DITA可用于技术手册、交互培训,教材、标准、报告、商业文档、贸易书籍、旅游和自然指南等书籍的编写。 

文档工程师跟产品工程师沟通各种产品的细节,形成文档的素材,然后根据这些素材编写相关手册。但是,公司所有人其实都产生内容,而文档工程师在企业里人数屈指可数,文档工程师输出的内容有限。

文档工程师熟悉XML/DITA及相关工具,这是他们的专业技能。但对于产品工程师、市场营销人员、经理等角色的人,他们不懂什么是XML,什么是DITA,让他们使用XML来写文档太为难他们了。怎样能让这些人不使用XML也能直接贡献内容而又不失去结构化文档的能力呢?

- 2 - 

解决方案

对于这种情况, OASIS在DITA的基础上设计了lwDITA ( Lightweight DITA), 简称为轻量级DITA。 

轻量级DITA(LwDITA)是达尔文信息类型体系结构(DITA)的简化版本。轻量级DITA通过以下改进让全员参与内容创作、协作和发布变为可能:

  1. 减少元素类型和属性集

  2. 使用更严格的内容模型

  3. 减少功能集

  4. 并支持3中不同格式编写 - XML,HTML5和Markdown

简而言之,非文档工程师使用类似于印象笔记的方式编写文档,文档工程师使用以上提到的3种格式的任意一种来编写,然后由文档工程师把各种格式的内容汇集然后统一发布。 

以下是轻量级DITA规范的整理:

赶快试试吧!

- 3 - 

参考

  • LightWeidht DITA

    http://docs.oasis-open.org/dita/LwDITA/v1.0/LwDITA-v1.0.html

代码转载自:https://pan.quark.cn/s/8ce4326d996e 对于在 CentOS 7 系统中修改网卡配置文件后无法使设置生效的情况,经过实践验证,可以通过使用 nmcli 命令来进行调整。完成修改之后,需要重新启动虚拟机以使更改生效,这样操作流程即告完成。如果设置仍然无法生效,则表明虚拟机在启动过程中所获取的 IP 地址配置并非针对 eth0,此时可以对其它网卡的配置文件进行修改或将其移除。在 CentOS 7 系统中,网络配置的管理机制与早期版本存在差异,主要体现为采用了 Network Manager 服务来负责网络接口的管理。在某些情形下,尽管修改了 `/etc/sysconfig/network-scripts` 目录下的 `ifcfg-eth0` 文件,但网络配置却未能即时生效。此类问题的发生通常源于 CentOS 7 采用了不同于以往的配置读取方法。接下来将具体阐述如何借助 nmcli 命令来处理这一挑战。 以 root 用户身份登录系统并打开终端界面。nmcli 是 Network Manager 提供的命令行界面工具,它支持在命令行环境下执行网络连接的建立、编辑、查询及管理任务。针对修改 eth0 网卡配置的需求,可以遵循以下步骤进行操作: 1. 导航至 `/etc/sysconfig/network-scripts` 目录: ``` cd /etc/sysconfig/network-scripts ``` 2. 检查该目录内是否存在 `ifcfg-eth0.bak` 文件,该备份文件可能是先前调整配置时遗留下来的,若存在可能造成冲突。若发现该文件,可以选择将其删除: ``` [root@localhost netw...
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值