首页 > 其他分享 >DITA Reuse的设计和管理

DITA Reuse的设计和管理

时间:2023-09-12 09:13:29浏览次数:35  
标签:Reuse 是否 重用 用户 Topic DITA 内容 设计 变更

1.Topic划分

以Topic为主要重用对象,就需要将整本手册切分为若干个Topic。第一次拆分时往往会沿用以前的章节划分,把一个小节,自然转换成一个Topic。

把所有章节填入表格,进行初次审阅:

  • 该小节是否完整回答了一个问题?是否包含了该问题以外的内容?

  • 该小节是否可以归为一个信息分类,如Concept、Task或Reference?

2.判断是否Topic是否覆盖所有内容

根据Topic的独立完整性要求,对小节的标题和类型进行调整,可以得到第一版的Topic列表。请回答一个问题:这个列表包含了全部的Topic吗?回答是:不知道。
可从两个方面:

  • 以上Topic是否覆盖了全部的用户场景?

  • 以上Topic是否包含了全部的产品特性?
    此方法为"信息双向分类"法,一个方向是信息应用的场景,表示为信息类型如:原理描述、接口说明、安装步骤、调试步骤等;
    另一个方向就是产品特性,表示为产品特性树或产品结构树。

3.变更管理

把文件夹复制一份,"重用"了全部的topic,但违背了内容重用的目的:信息同源。
另一方面,技术内容的全生命周期维护需求也越来越高了。换句话说,一本手册交付给用户以后,如果该用户的设备出现了维护或升级,是否还能够同步更新该用户的手册?很显然,互联网时代的用户对此有着越来越高的预期。

因此,内容交付的变更管理,应该从内容设计之初就进行规划。

  • 每种粒度的内容都要建立唯一的编码机制。不管是手册,还是topic、被管理重用的段落、术语、都要有唯一的ID,以便于版本识别。

  • 不同语言之间,要建立同一模板的关联关系。这样一个Topic翻译之后不需要整个重复翻译,变更时只需要再次翻译有更改的Topic。

  • 要建立发布分基线管理。每一本交付的手册,要记录当时的发布结果,不只是发布的PDF或网页,是当时的版本。

  • 建立变更追溯关系。每次考虑变更同步时,不仅要考虑Topic本身,还要兼顾改Topic关联的其他内容,如图、引用的段落或短语、指向其他的Topic,和引用了该Topic的其他内容。

内容重用设计是基于用户场景分析,围绕产品结构或功能树,综合考虑配置和变更管理的一项工作。要提高设计的合理性,就必须不断验证,根据验证的结果不断调整。

标签:Reuse,是否,重用,用户,Topic,DITA,内容,设计,变更
From: https://www.cnblogs.com/jianjiana/p/17692860.html

相关文章

  • Qt/C++音视频开发52-采集本地屏幕桌面的终极设计
    一、前言最开始设计的时候,只考虑了一个屏幕的情况,这种当然是最理想的情况,实际上双屏或者多屏的用户也不在少数,比如我这两个屏幕,屏幕1是1080P,屏幕2是2K分辨率,打印两个屏幕的区域是QRect(0,01920x1030),QRect(1920,-2082560x1390),可以看到有个负数值(可以在操作系统中的排列显示......
  • 基于微信小程序的高校宿舍报修系统-计算机毕业设计源码+LW文档
    一、研究背景及意义研究背景:学生宿舍是学生学习,生活,休息,交往的重要场所,做好宿舍管理工作,构建安全校园,是校园管理的一项重要任务。目前我们传统的宿舍管理存在一些弊端,传统考勤制度,信息传达不及时,依赖人工管理,人员管理过程冗杂,无精准数据分析,宿舍安全隐患,家校无法互通等问题。在我......
  • 综合性养老服务平台的设计与实现-计算机毕业设计源码+LW文档
    一、研究的背景意义当前,随着我国老龄化程度加急,各地纷纷构建高品质的养老院来适应城市的发展,养老院品质的上升并不等于养老院服务质量的上升,这就对养老院管理提出更高的要求。在传统的养老院管理中,许多工作都是依靠人力去解决。比如老人管理、水电费管理需要通过工人进行记录,往往积......
  • 微信小程序校园服务平台的设计与实现-计算机毕业设计源码+LW文档
    研究现状:1.国外研究现状早在2015年,设计师弗朗西斯·贝里曼和GoogleChrome的工程师亚历克斯·罗素提出“PWA(渐进式网络应用程序)”概念,其核心目标就是提升WebApp的性能,改善WebApp的用户体验。媲美Native的流畅体验,将网络之长与应用之长相结合。根据Google开发者支持页面,PWA相关......
  • 基于大数据的校园精准精扶贫机制的分析与实现-计算机毕业设计源码+LW文档
    一、研究的背景意义所谓大数据技术,主要指能够进行传统常规软件无法处理的海量数据的数据统计、处理、挖掘和分析等相关技术。大数据技术的重点不是获取和存储海量的数据信息,而是对这些海量数据信息进行专业化处理。大数据技术离不开云计算,云计算为大数据技术的应用提供了基本的设......
  • 基于Android毕业生管理系统的设计与实现-计算机毕业设计源码+LW文档
    一、研究的背景意义高校是培养人才的地方,对智能化发展非常重视,教育部搭建的教育网,专门为教育教学提供帮助。利用教育网的基础搭建各种管理系统,实现校园内信息的有效管理,对教育教学、学生生活、高校宣传等进行综合管理。在毕业生管理中,功能模块的数据通过数据库存储,并为各个模块预......
  • 2.1 Java程序设计基础
    1Java程序设计基础1.1要想编写规范、可读性高的Java程序,就必须对Java基本语法有所了解。基本语法是所有编程语言都必须掌握的基础知识,也是整个程序代码不可缺少的重要部分。一个Java程序通常由数据类型、变量、运算符和控制流程语句4部分组成。其中数据类型和运算符不仅......
  • 【设计模式】观察者模式Observer:消息的订阅-发布
    (目录)观察者模式是一种非常流行的设计模式,也常被叫作订阅-发布模式。观察者模式在现代的软件开发中应用非常广泛,比如,商品系统、物流系统、监控系统、运营数据分析系统等。常说的基于事件驱动的架构,其实也是观察者模式的一种最佳实践。当观察某一个对象时,对象传递出的每一个行......
  • 5.前端设计模式之容器/展现模式
    Enforceseparationofconcernsbyseparatingtheviewfromtheapplicationlogic通过将视图层和应用逻辑分离实现关注点分离 这个有点像Java应用开发中经常看到的MVC架构模式,实现数据、业务逻辑和展示层分离。这个模式在React中需要两个组件实现:容器组件主要负责获取数据,获取......
  • 【设计模式】备忘录模式Memento - 在聊天会话中记录历史消息
    (目录)相较于其他设计模式,备忘录模式不算太常用,但好在这个模式理解、掌握起来并不难,代码实现也比较简单,应用场景更是比较明确和有限。一般应用于编辑器或会话上下文中防丢失、撤销、恢复等场景中。模式原理分析备忘录模式的原始定义是:捕获并外部化对象的内部状态,以便以后可......