一. Task topic
目标
记录实现某个目标的步骤指导。
注意事项
1. 动名词开头或使用祈使句。
2. 使用有序列表展示步骤。
3. 最好不要超过九个步骤 (Add the lengthy conceptual and reference information to other topics and provide links to that information from the task topic.)
4. 提供下一个 task 或者用户需要了解的概念的的链接。
标题
1. 应保证标题简洁、清楚。Task titles must be precise and distinct and clearly convey what the task is.
2. 使用动名词开头，而不是动词。
3. 尽可能使用名词的复数形式。
4. 以使用者的视角写标题。
5. 标题应完整、具体。用户通过标题可以了解该主题包含的内容。
框架
1. A task topic starts with an introductory paragraph that specifies the purpose or rationale for performing the task. In DITA, this information is referred to as the short description.
开始任务主题时，先简要描述该任务的目标、上下文、影响、限制条件、使用者、前提条件等。
正确：
Prerequisites
To [do task], you need SYSADM authority or CREATE privilege on the table.
Prerequisite
错误：
Do not create an inline link that is part of a sentence.
Prerequisite
Before you can access the LAN on the system, you need to Create a new connection.
2. 写作 steps 需要注意以下事项：
a. 先定位 UI 位置，再执行操作。
In the Properties window, click OK.
b. 先描述目的，再执行操作。
To open the Properties window, right-click thedatabase icon and click Open.
c. 如果某个步骤是可选的，可以使用 Optional.
Optional: Restart the connection by selectingRestart.
d. 正确使用超级主题（supertask）
Managing digital certificates by expiration
General information about managing digital certificates by expiration...
Starting Digital Certificate Manager
e. 确保客户知道当前任务完成后，应如何进行后续操作。
Next: Restarting the system
f. 关于 code.
Label the link to the code so that the purpose of the code is clear to users, for example, Code for an SQL table.
g. 正确使用 Tip.
Tip: To start multiple connections, select each connection that you want to start, right-click it, and select Start.
二. Concept topics
目标
让用户理解产品使用的相关概念。
注意事项
1. 使用名词或名词短语作标题。
2. 如果内容太多，可以使用子标题对内容进行划分。
3. 使用图片加深用户的理解。
4. 使用样例加深用户的理解。
5. 确保概念主题简洁、完整。
标题
1. 尽量使用复数。
2. 使用名词或名词短语作标题。
3. 关键词尽量放在标题开头。
4. 标题信息应该具体、完整。用户能通过标题了解其内容。
框架
概念内容：
1. 是什么
2. 用户需要了解的背景知识
3. 好处、优点
4. 与其他概念的关系
5. 使用限制
6. 重要性
7. 产品行为为何以及如何变化
其它注意事项
1. 使用图片加深用户的理解。
2. 使用样例加深用户的理解。
3. 如果内容太多，可以使用子标题对内容进行划分。
4. 善用 related tasks/reference/information。示例如下：
Related tasks
三. Reference topics
目标
用户可以快速定位需要的信息。Provide quick access to information that users are likely to need as they complete tasks.
注意事项
1. 使用名词或名词短语作标题，不要用冠词 (a,an, orthe) 开头。
2. Do not write long explanations; assume that readers understand the basic technology.
3. You can also use tables and bulleted or definition lists to help users scan for information quickly.
4. Use a consistent format so that users can find informationquickly.
5. Reference information should be easy to scan to allows readers to quickly find information.
分类
APIs
Class descriptions
Commands
INI settings
Keyboard shortcuts
Language elements
Protocols
Schemas
Settings
Statements
Symbols
Templates
四. Container topics
目标
Remember that the main purpose of a container topic is tointroduce and organize a group of child topics. Container topics provide structure in the navigation, a sense of relationships between topics, and additional explanation of the relationships as appropriate. They serve as launching points and introductions to their child topics, and help users keep their bearings in relation to the whole set of information.
有效性分析
1. providing appropriate child or related links, briefly introducing the child topics, and adhering to short description guidelines. 提供合理的子链接和相关链接
2. 简要介绍子主题
3. 简要描述主题
五. Short description
目标
提高信息可读性，改善用户阅读体验。Effective short descriptions for task topics provide users with enough information to know whether they are interested in the task. Effective short descriptions for task containers provide enough information to know what the main task and its subtasks accomplish.
注意事项
1. 不要使用 list, table, 或 figure。
2. 使用完整的句子，而不是短语。
3. 不要使用 "This topic describes...," 或 "This topic is about...."。
4. Fragments are acceptable in only one instance: API reference topics.
5. 不同类型的topic 注意事项不同，具体如下：
Task topics：
1. 使用 DITA 标签。
2. 确保一到两段话，不超过50 个字。
3. 应该介绍该任务的目标、原因、好处、必要性，什么场景下做这个任务，不要重复标题。
Concept Topics:
1. 使用 DITA 标签。
2. 确保一到两段话，不超过50 个字。
3. 介绍概念 what is it? why I care about this? What I need to pay attention about the concept?
Reference Topics:
1. 使用 DITA 标签。
2. 确保一到两段话，不超过50 个字。
3. 介绍概念 what the reference item does, what it is, or what it is used for。
