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: manual/2-populate-the-structure/templates/procedure/procedure-template.md
+53-50Lines changed: 53 additions & 50 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -90,7 +90,7 @@ This note-type callout is exclusively to alert readers about what roles, permiss
90
90
- One callout maximum per section <!-- PROC-STRUCT-CALLOUTS-PER-SECTION-ONE -->
91
91
- Keep each callout concise (≤ 2 short sentences). If the content needs a list or multiple paragraphs, move it into the body under a heading. <!-- PROC-BEHAV-CALLOUTS-CONCISE -->
92
92
- Ensure the callout content is directly relevant to the nearby task or decision point. <!-- PROC-BEHAV-CALLOUTS-RELEVANT -->
93
-
- Use the appropriate type: `Tip`, `Note`, `Important`, or `Caution`. <!-- PROC-BEHAVE-CALLOUTS-TYPE -->
93
+
- Use the appropriate type: `Tip`, `Note`, `Important`, or `Caution`. <!-- PROC-BEHAV-CALLOUTS-TYPE -->
94
94
- Do **not** include full procedural steps or long prerequisite checklists inside callouts. Put steps in the main flow; keep prerequisite lists in "Before you start." <!-- PROC-BEHAV-CALLOUTS-NO-STEPS -->
95
95
- For the allowed callout types and when to use them, see the [writing rules](../../3-validating-design/writing-rules/README.md). <!-- PROC-BEHAV-CALLOUTS-TYPES-REFER-STYLEGUIDE -->
96
96
@@ -176,41 +176,44 @@ Check out the [procedure example](./procedure-example.md).
| Step intro | Paragraph | No |`PROC-STRUCT-SEC-INTRO`| PROC-TASK-INTRO |
203
+
| Step callout | Callout | No |`PROC-STRUCT-SEC-CALLOUT`| PROC-TASK-CALLOUTS |
204
+
| Step list | Numbered list or checkboxes (1) | Yes |`PROC-STRUCT-SEC-STEPS`| PROC-TASK-STEP |
205
+
| Clarifiers | Bullets under a step (depth 1) (2) | No |`PROC-STRUCT-SEC-CLAR`| PROC-TASK-CLAR |
206
+
| Code | Fenced code block under the step (3)| No |`PROC-STRUCT-SEC-CODE`| PROC-TASK-CODE |
207
+
| Screenshot | Image under the step (3) | No |`PROC-STRUCT-SEC-IMG`| PROC-TASK-IMG |
208
+
209
+
(1) Use checkboxes only for unordered or long-running tasks. Numbered lists are the default for procedures.
210
+
(2) Use a short bullet list for clarifiers or alternatives. Do not create numbered sub-steps.
211
+
(3) Nest code and images inside the list item they clarify (indent so they are children of the preceding step).
208
212
209
213
Additional structural constraints:
210
214
211
215
- The first section title must be `Step 1:` and subsequent section titles must increment by 1. <!-- PROC-STRUCT-SEC-ORDER-ASC -->
212
-
- Each "Step {n}" section contains **exactly one** ordered list of actions. <!-- PROC-STRUCT-SEC-ONE-OL -->
213
-
- Do not insert headings, callouts, or tables **between** list items; place them either within the list item they clarify or after the list. <!-- PROC-STRUCT-SEC-NO-HEADINGS-IN-LIST -->
216
+
- Each "Step {n}" section contains exactly one ordered list of actions. <!-- PROC-STRUCT-SEC-ONE-OL -->
- In the sectioned layout, prefix with `Step {n}:` starting at 1 and incrementing by 1. <!-- PROC-STRUCT-SEC-H2-STEP-PREFIX -->
@@ -231,43 +234,43 @@ Use these guidelines for both flat and sectioned procedure layouts. <!-- PROC-BE
231
234
- Avoid one- or two-word titles. <!-- PROC-BEHAV-TASK-TITLE-NO-ONE-TWO-WORD -->
232
235
- Don’t use punctuation marks in titles (colons, semicolons, dashes) except in the sectioned layout (`Step {n}:`). <!-- PROC-BEHAV-TASK-TITLE-NO-PUNCT -->
- When adding paragraphs, images, or code under a step, insert a blank line and indent so they are children of that step. <!-- PROC-STRUCT-STEP-NESTING -->
256
-
- Bold UI elements (buttons, menus, options). <!-- PROC-BEHAV-STEP-UI-BOLD -->
257
-
- Use inline code for commands, filenames, paths, and output. <!-- PROC-BEHAV-STEP-CODE-INLINE -->
258
-
- Don’t use external links in steps; only same-page anchors. <!-- PROC-BEHAV-STEP-LINKS-INTERNAL -->
259
-
- For UI paths, put location before action. <!-- PROC-BEHAV-STEP-LOCATION-FIRST -->
260
-
- For conditions, write the result first, then the condition. <!-- PROC-BEHAV-STEP-RESULT-THEN-CONDITION -->
251
+
- Use a numbered list when the task is completed in one go. <!-- PROC-BEHAV-TASK-STEP-ORDERED-ONEGO -->
252
+
- Use checkboxes when steps are unordered or spread over time. <!-- PROC-BEHAV-TASK-STEP-CHECKBOX-UNORDERED -->
253
+
- Start each step with an imperative verb; avoid -ing forms. <!-- PROC-BEHAV-TASK-STEP-IMPERATIVE -->
254
+
- One step = one user action (combine only trivial actions). <!-- PROC-BEHAV-TASK-STEP-ONE-ACTION -->
255
+
- Author ordered lists with `1.` for every item (1, 1, 1 …). <!-- PROC-STRUCT-TASK-STEP-OL-ONE -->
256
+
- Aim for 2–7 steps. Split if longer. <!-- PROC-BEHAV-TASK-STEP-COUNT-2-7 -->
- When adding paragraphs, images, or code under a step, insert a blank line and indent so they are children of that step. <!-- PROC-STRUCT-TASK-STEP-NESTING -->
259
+
- Bold UI elements (buttons, menus, options). <!-- PROC-BEHAV-TASK-STEP-UI-BOLD -->
260
+
- Use inline code for commands, filenames, paths, and output. <!-- PROC-BEHAV-TASK-STEP-CODE-INLINE -->
261
+
- Don’t use external links in steps; only same-page anchors. <!-- PROC-BEHAV-TASK-STEP-LINKS-INTERNAL -->
262
+
- For UI paths, put location before action. <!-- PROC-BEHAV-TASK-STEP-LOCATION-FIRST -->
263
+
- For conditions, write the result first, then the condition. <!-- PROC-BEHAV-TASK-STEP-RESULT-THEN-CONDITION -->
0 commit comments