diff options
Diffstat (limited to 'doc/development/documentation/topic_types/task.md')
| -rw-r--r-- | doc/development/documentation/topic_types/task.md | 13 |
1 files changed, 11 insertions, 2 deletions
diff --git a/doc/development/documentation/topic_types/task.md b/doc/development/documentation/topic_types/task.md index 60508fbf6ee..78d670a16d6 100644 --- a/doc/development/documentation/topic_types/task.md +++ b/doc/development/documentation/topic_types/task.md @@ -52,14 +52,23 @@ To create an issue: The issue is created. You can view it by going to **Issues > List**. ``` -## Task headings +## Task topic titles -For the heading text, use the structure `active verb` + `noun`. +For the title text, use the structure `active verb` + `noun`. For example, `Create an issue`. If you have several tasks on a page that share prerequisites, you can use the title `Prerequisites` and link to it. +## Task introductions + +To start the task topic, use the structure `active verb` + `noun`, and +provide context about the action. +For example, `Create an issue when you want to track bugs or future work`. + +To start the task steps, use a succinct action followed by a colon. +For example, `To create an issue:` + ## Related topics - [View the format for writing task steps](../styleguide/index.md#navigation). |