Topic authoring checklist

Last Updated : May 19, 2021 |

Use the check list as reference. You do not have to mark each item when you complete the task.

#

Task

1.

Create a new topic in Tridion Docs or check out an existing topic.

2.

Give the topic a title that is correct for its type. For converted and renamed topics, change the title if it is not correct for the type.

3.

Insert a comment at the top of the topic to list any topics for which a relationship should be identified. You will create those relationships in the map topics.

4.

Insert the required content, and tag all the content semantically. If you have any questions on the correct tag to use, look at the tag help or contact your IA.

5.

Ensure that you are using conrefs and reusable topic elements appropriately, as determined by your project.

6

Ensure that you add conditions in topics and maps, preview conditions, and select the conditions in the Conditions tab of Publication Manager, as determined by your project.

7.

Add the appropriate index entries.

8.

Delete any empty elements. For example, if you are working on a task topic and you do not have any prerequisites, delete the prereq element.

9.

Remove any comments from the default topic or tag template.

10.

Perform a spell check on the topic (Edit > Check spelling).

11.

Perform a completeness check on the topic (Document > Validate).