Skip to content

Commit 060174c

Browse files
committed
(#47) keep procedure layout IDs consistent + minor fixes
1 parent cc34bed commit 060174c

File tree

1 file changed

+53
-50
lines changed

1 file changed

+53
-50
lines changed

manual/2-populate-the-structure/templates/procedure/procedure-template.md

Lines changed: 53 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ This note-type callout is exclusively to alert readers about what roles, permiss
9090
- One callout maximum per section <!-- PROC-STRUCT-CALLOUTS-PER-SECTION-ONE -->
9191
- 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 -->
9292
- 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 -->
9494
- 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 -->
9595
- 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 -->
9696

@@ -176,41 +176,44 @@ Check out the [procedure example](./procedure-example.md).
176176
177177
### Procedure layout: flat <!-- group: PROC-STRUCT-FLAT -->
178178

179-
| Element | Format | Required | ID | Rules |
180-
|:---------------|:-------------------------------------|:---------|:---------------------------|:--------------------|
181-
| Task title | H2 | Yes | `PROC-STRUCT-FLAT-TITLE` | PROC-TASK-TITLE |
182-
| Task intro | Paragraph | No | `PROC-STRUCT-FLAT-INTRO` | PROC-TASK-INTRO |
183-
| Task callout | Callout | No | `PROC-STRUCT-FLAT-CALLOUT` | PROC-CALLOUTS |
184-
| Steps list | Numbered list or checkboxes (1) | Yes | `PROC-STRUCT-FLAT-STEPS` | PROC-STEP |
185-
| Clarifiers | Bullets under a step (depth 1) (2) | No | `PROC-STRUCT-FLAT-CLAR` | PROC-CLARIFIERS |
186-
| Code | Fenced code block under the step (3) | No | `PROC-STRUCT-FLAT-CODE` | PROC-CODE |
187-
| Screenshot | Image under the step (3) | No | `PROC-STRUCT-FLAT-IMG` | PROC-SHOT |
179+
| Element | Format | Required | ID | Rules |
180+
|:-------------|:------------------------------------|:---------|:--------------------------|:-------------------|
181+
| Task title | H2 | Yes | `PROC-STRUCT-FLAT-TITLE` | PROC-TASK-TITLE |
182+
| Task intro | Paragraph | No | `PROC-STRUCT-FLAT-INTRO` | PROC-TASK-INTRO |
183+
| Task callout | Callout | No | `PROC-STRUCT-FLAT-CALLOUT`| PROC-TASK-CALLOUTS |
184+
| Steps list | Numbered list or checkboxes (1) | Yes | `PROC-STRUCT-FLAT-STEPS` | PROC-TASK-STEP |
185+
| Clarifiers | Bullets under a step (depth 1) (2) | No | `PROC-STRUCT-FLAT-CLAR` | PROC-TASK-CLAR |
186+
| Code | Fenced code block under the step (3)| No | `PROC-STRUCT-FLAT-CODE` | PROC-TASK-CODE |
187+
| Screenshot | Image under the step (3) | No | `PROC-STRUCT-FLAT-IMG` | PROC-TASK-IMG |
188188

189189
(1) Use checkboxes only for unordered or long-running tasks. Numbered lists are the default for procedures.
190190
(2) Use a short bullet list for clarifiers or alternatives. Do not create numbered sub-steps.
191191
(3) Nest code and images inside the list item they clarify (indent so they are children of the preceding step).
192192

193-
> **Note**
193+
> **Note:**
194194
>
195195
> The "Rules" column points to the shared rule group that governs this element (see [Procedure guidelines](#procedure-guidelines)).
196196
197197
### Procedure layout: sectioned <!-- group: PROC-STRUCT-SEC -->
198198

199-
| Element (per step) | Format | Required | ID | Rules |
200-
|:-------------------|:--------------------------------|:--------:|:--------------------------|:----------------|
201-
| Step title | H2 `Step {n}: …` | Yes | `PROC-STRUCT-SEC-TITLE` | PROC-TASK-TITLE |
202-
| Step intro | Paragraph | No | `PROC-STRUCT-SEC-INTRO` | PROC-TASK-INTRO |
203-
| Step callout | Callout | No | `PROC-STRUCT-SEC-CALLOUT` | PROC-CALLOUTS |
204-
| Step actions | Numbered list (exactly one) | Yes | `PROC-STRUCT-SEC-STEPS` | PROC-STEP |
205-
| Clarifiers | Bullets under a step (depth 1) | No | `PROC-STRUCT-SEC-CLAR` | PROC-CLARIFIERS |
206-
| Code | Fenced code block under the step| No | `PROC-STRUCT-SEC-CODE` | PROC-CODE |
207-
| Screenshot | Image under the step | No | `PROC-STRUCT-SEC-IMG` | PROC-SHOT |
199+
| Element (per step) | Format | Required | ID | Rules |
200+
|:-------------------|:------------------------------------|:---------|:--------------------------|:-------------------|
201+
| Step title | H2 `Step {n}: …` | Yes | `PROC-STRUCT-SEC-TITLE` | PROC-TASK-TITLE |
202+
| 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).
208212

209213
Additional structural constraints:
210214

211215
- 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 -->
214217

215218
> **Note**
216219
>
@@ -220,7 +223,7 @@ Additional structural constraints:
220223

221224
Use these guidelines for both flat and sectioned procedure layouts. <!-- PROC-BEHAV-GUIDE-APPLIES-BOTH -->
222225

223-
### Title <!-- group: PROC-TASK-TITLE -->
226+
### Task/Step Title <!-- group: PROC-TASK-TITLE -->
224227

225228
- Procedure section titles are Markdown H2 headings. <!-- PROC-STRUCT-TASK-H2 -->
226229
- 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
231234
- Avoid one- or two-word titles. <!-- PROC-BEHAV-TASK-TITLE-NO-ONE-TWO-WORD -->
232235
- Don’t use punctuation marks in titles (colons, semicolons, dashes) except in the sectioned layout (`Step {n}:`). <!-- PROC-BEHAV-TASK-TITLE-NO-PUNCT -->
233236

234-
### Task intro (optional) <!-- group: PROC-TASK-INTRO -->
237+
### Task/Step intro (optional) <!-- group: PROC-TASK-INTRO -->
235238

236239
- Write 1–2 short sentences that provide context. <!-- PROC-BEHAV-TASK-INTRO-BRIEF -->
237240
- Do not repeat the task title wording. <!-- PROC-BEHAV-TASK-INTRO-NO-REPEAT -->
238241
- Add cross-references here, not inside steps. <!-- PROC-BEHAV-TASK-INTRO-LINKS -->
239242

240-
### Task callout (optional) <!-- group: PROC-CALLOUTS -->
243+
### Task/Step callout (optional) <!-- group: PROC-TASK-CALLOUTS -->
241244

242-
- Use one callout after the intro for important notes, warnings, or tips. <!-- PROC-STRUCT-CALLOUTS-AFTER-INTRO -->
243-
- Do not place callouts between steps. <!-- PROC-STRUCT-CALLOUTS-NO-BETWEEN-STEPS -->
244-
- One callout maximum per task. <!-- PROC-STRUCT-CALLOUTS-PER-TASK-ONE -->
245+
- Use one callout after the intro for important notes, warnings, or tips. <!-- PROC-STRUCT-TASK-CALLOUTS-AFTER-INTRO -->
246+
- Do not place callouts between steps. <!-- PROC-STRUCT-TASK-CALLOUTS-NO-BETWEEN-STEPS -->
247+
- One callout maximum per task. <!-- PROC-STRUCT-TASK-CALLOUTS-PER-TASK-ONE -->
245248

246-
### Steps list guidelines <!-- group: PROC-STEP -->
249+
### Steps list guidelines <!-- group: PROC-TASK-STEP -->
247250

248-
- Use a numbered list when the task is completed in one go. <!-- PROC-BEHAV-STEP-ORDERED-ONEGO -->
249-
- Use checkboxes when steps are unordered or spread over time. <!-- PROC-BEHAV-STEP-CHECKBOX-UNORDERED -->
250-
- Start each step with an imperative verb; avoid -ing forms. <!-- PROC-BEHAV-STEP-IMPERATIVE -->
251-
- One step = one user action (combine only trivial actions). <!-- PROC-BEHAV-STEP-ONE-ACTION -->
252-
- Author ordered lists with `1.` for every item (1, 1, 1 …). <!-- PROC-STRUCT-STEP-OL-ONE -->
253-
- Aim for 2–7 steps. Split if longer. <!-- PROC-BEHAV-STEP-COUNT-2-7 -->
254-
- Avoid one-step tasks. <!-- PROC-BEHAV-STEP-NO-ONE -->
255-
- 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 -->
257+
- Avoid one-step tasks. <!-- PROC-BEHAV-TASK-STEP-NO-ONE -->
258+
- 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 -->
261264

262-
### Clarifiers (optional) <!-- group: PROC-CLARIFIERS -->
265+
### Task/Step Clarifiers (optional) <!-- group: PROC-TASK-CLAR -->
263266

264-
- Don't use numbered substeps beneath a step (nested ordered lists). <!-- PROC-STRUCT-CLARIFIERS-NO-ORDERED -->
265-
- Use bullets for subactions, such as clarifiers or alternatives. <!-- PROC-STRUCT-CLARIFIERS-BULLETS -->
266-
- Limit clarifiers to 2–4 items in one level. <!-- PROC-BEHAV-CLARIFIERS-COUNT-2-4 -->
267+
- Don't use numbered substeps beneath a step (nested ordered lists). <!-- PROC-STRUCT-TASK-CLAR-NO-ORDERED -->
268+
- Use bullets for subactions, such as clarifiers or alternatives. <!-- PROC-STRUCT-TASK-CLAR-BULLETS -->
269+
- Limit clarifiers to 2–4 items in one level. <!-- PROC-BEHAV-TASK-CLAR-COUNT-2-4 -->
267270

268-
### Task code (optional) <!-- group: PROC-CODE -->
271+
### Task/Step code (optional) <!-- group: PROC-TASK-CODE -->
269272

270-
Follow the code rules in the Style Guide. <!-- PROC-BEHAV-CODE-REFER-STYLEGUIDE -->
273+
Follow the code rules in the Style Guide. <!-- PROC-BEHAV-TASK-CODE-REFER-STYLEGUIDE -->
271274

272275
**Example:**
273276

@@ -277,9 +280,9 @@ Follow the code rules in the Style Guide. <!-- PROC-BEHAV-CODE-REFER-STYLEGUIDE
277280
gh workflow run build --repo org/repo
278281
```
279282

280-
### Task screenshot (optional) guidelines <!-- group: PROC-SHOT -->
283+
### Task/Step screenshot (optional) <!-- group: PROC-TASK-IMG -->
281284

282-
See the [writing rules] for screenshots (../../3-validating-design/writing-rules/README.md). <!-- PROC-BEHAV-SHOT-REFER-STYLEGUIDE -->
285+
See the [writing rules] for screenshots (../../3-validating-design/writing-rules/README.md). <!-- PROC-BEHAV-TASK-SHOT-REFER-STYLEGUIDE -->
283286

284287
## FAQ / Troubleshooting (optional) <!-- group: PROC-EXTRA -->
285288

0 commit comments

Comments
 (0)