From 748e07a7a46a1bc3634b3641ec1eefa216a9c356 Mon Sep 17 00:00:00 2001 From: Maria Zlatkova Date: Wed, 8 Jun 2016 17:55:05 +0300 Subject: [PATCH] [contributor] Editorial changes Minor edits to the Topic structure section. Change-Id: Ic274e0b97726f684e14866626d428390ca659e05 --- doc/contributor-guide/source/topic-structure.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/contributor-guide/source/topic-structure.rst b/doc/contributor-guide/source/topic-structure.rst index 8affe38159..1ed2face63 100644 --- a/doc/contributor-guide/source/topic-structure.rst +++ b/doc/contributor-guide/source/topic-structure.rst @@ -19,7 +19,7 @@ any topic. Therefore, each topic represents an independent piece of information. Each topic states prerequisites and dependencies, if any, as well as providing information about the next steps. -In topic-based authoring a chunk of information is called `topic`. +In topic-based authoring, a chunk of information is called a `topic`. Structure the information around the following topics: @@ -41,10 +41,10 @@ Structure the information around the following topics: **Task** A task topic provides a sequence of steps detailing how to achieve a - certain task. A section (or chapter) is the high level task topic. + certain task. A section (or chapter) is the high-level task topic. Typically, a section includes multiple sub-sections: task, concept, and - reference topics. Start the title of a high level task topic with a verb + reference topics. Start the title of a high-level task topic with a verb in gerund and the title of a subtask topic with a verb in imperative. Task topics are the most important topics in any technical documentation.