You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/style-guide/structuring-the-content.md
+24Lines changed: 24 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -99,6 +99,30 @@ A procedure describes how to complete an action using a series of steps. Procedu
99
99
100
100

101
101
102
+
| Element | # | Style | Required | Notes |
103
+
| --- | --- | --- | --- | --- |
104
+
| Title | 1 | H1 | Yes ||
105
+
| Screenshot | 2 | PNG / GIF | No | The screenshot shows the area in the app where the discussion or action takes place.</br>Reference-only topics (tables) don't require this screenshot. |
106
+
| Admonition | 3 | Admonition | No | This admonition is exclusively to alert readers about the feature availability.</br>For example, a feature is only available to specific application roles or available after completing another task. |
107
+
| Introduction | 4 | Paragraph |**Yes**| A brief discussion of the functionality and its relationship with other functionalities.</br>The introduction answers the "what is this" |
108
+
| Example | 5 | Paragraph | No | An example explaining the functionality in context.</br>The example answers "why it matters." |
109
+
| "What to expect" title | 6 | H3 | No | H3 title reads "What to expect." |
110
+
| "What to expect" list | 7 | Unordered list | No | A paragraph explaining what will happen after completing the task. |
111
+
| Admonition | 8 | Admonition | No | General notes, tips, or warnings about the task. |
112
+
| Tasks title | 9 | H2 |**Yes**||
113
+
| Task introduction | 10 | Paragraph | No | A short sentence describing prerequisites or things to consider before the task. |
114
+
| Task steps | 11 | Ordered list |**Yes**| Procedural description.</br>Tasks and subtasks answer "how to use it." |
115
+
| Task screenshot | 12 | PNG / GIF | No | The screenshot goes after the last step in the procedure. |
116
+
| Task admonition | 13 | Admonition | No | Notes, tips, or warnings about the task. |
117
+
| Subtask title | 14 | H3 | No ||
118
+
|~~Subtask introduction~~|||| Subtasks don't include an introduction sentence. |
119
+
| Subtask steps | 15 | Ordered list | No | Procedural description.</br>Tasks and subtasks answer "how to use it." |
120
+
| Subtask screenshot | 16 | PNG / GIF | No ||
121
+
| Subtask admonition | 17 | Admonition | No | Notes, tips, or warnings about the task. |
122
+
| Common questions title | 18 | H2 | No | H2 title reads "Common questions". |
123
+
| Common question subtitle | 19 | H3 | No | Common question subtitle. |
124
+
| Common question paragraph | 20 | Paragraph | No | Answer to the common question. |
0 commit comments