diff options
Diffstat (limited to 'doc/development/documentation/structure.md')
| -rw-r--r-- | doc/development/documentation/structure.md | 13 |
1 files changed, 11 insertions, 2 deletions
diff --git a/doc/development/documentation/structure.md b/doc/development/documentation/structure.md index 33bfc040bb6..67bdbffa2a1 100644 --- a/doc/development/documentation/structure.md +++ b/doc/development/documentation/structure.md @@ -58,6 +58,9 @@ Don't tell them **how** to do this thing. Tell them **what it is**. If you start describing another topic, start a new concept and link to it. +Also, do not use "Overview" or "Introduction" for the topic title. Instead, +use a noun or phrase that someone would search for. + Concept topics should be in this format: ```markdown @@ -111,13 +114,16 @@ Prerequisites: To create an issue: 1. Go to **Issues > List**. -1. In the top right, click **New issue**. +1. In the top right, select **New issue**. 1. Complete the fields. (If you have a reference topic that lists each field, link to it here.) -1. Click **Create issue**. +1. Select **Create issue**. The issue is created. You can view it by going to **Issues > List**. ``` +If you have several tasks on a page that share prerequisites, you can make a +reference topic with the title **Prerequisites**, and link to it. + ## Reference A reference topic provides information in an easily-scannable format, @@ -133,6 +139,9 @@ Introductory sentence. | **Name** | Descriptive sentence about the setting. | ``` +If a feature or concept has its own prerequisites, you can use the reference +topic type to create a **Prerequisites** header for the information. + ## Troubleshooting Troubleshooting topics can be one of two categories: |