Skip to content

Commit cdcf226

Browse files
author
Marek Suchánek
committed
Update the modular templates to the latest upstream version
1 parent 747445e commit cdcf226

File tree

4 files changed

+38
-18
lines changed

4 files changed

+38
-18
lines changed

templates/assembly.adoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The ID is an anchor that links to the module. Avoid changing it after the module
1616
////
1717

1818
////
19-
Indicate the module type in one of the following
19+
Indicate the content type in one of the following
2020
ways:
2121
Add the prefix assembly- or assembly_ to the file name.
2222
Add the following attribute before the module ID:
@@ -31,6 +31,8 @@ ifdef::context[]
3131
endif::[]
3232
= {{module_title}}
3333
////
34+
Be sure to include a line break between the title and the :context: variable and the :context: variable and the assembly introduction.
35+
3436
If the assembly covers a task, start the title with a verb in the gerund form, such as Creating or Configuring.
3537
////
3638
@@ -66,6 +68,7 @@ include::modules/TEMPLATE_CONCEPT_explaining_a_concept.adoc[leveloffset=+1]
6668
[leveloffset=+1] ensures that when a module title is a level 1 heading (= Title), the heading will be interpreted as a level-2 heading (== Title) in the assembly. Use [leveloffset=+2] and [leveloffset=+3] to nest modules in an assembly.
6769
6870
include::modules/TEMPLATE_PROCEDURE_doing_one_procedure.adoc[leveloffset=+2]
71+
// Add a blank line after each 'include::' statement.
6972
7073
include::modules/TEMPLATE_PROCEDURE_reference-material.adoc[leveloffset=2]
7174
////

templates/concept.adoc

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ The `context` attribute enables module reuse. Every module ID includes {context}
2323
= {{module_title}}
2424
////
2525
In the title of concept modules, include nouns or noun phrases that are used in the body text. This helps readers and search engines find the information quickly. Do not start the title of concept modules with a verb. See also _Wording of headings_ in _The IBM Style Guide_.
26+
27+
Be sure to include a line break between the title and the module introduction.
2628
////
2729

2830
{% if examples -%}
@@ -32,7 +34,17 @@ The contents of a concept module give the user descriptions and explanations nee
3234

3335
* Look at nouns and noun phrases in related procedure modules and assemblies to find the concepts to explain to users.
3436
* Explain only things that are visible to users. Even if a concept is interesting, it probably does not require explanation if it is not visible to users.
35-
* Do not include any instructions to perform an action, such as executing a command. Action items belong in procedure modules.
37+
* Avoid including action items. Action items belong in procedure modules. However, in some cases a concept or reference can include suggested actions when those actions are simple, are highly dependent on the context of the module, and have no place in any procedure module. In such cases, ensure that the heading of the concept or reference remains a noun phrase and not a gerund.
38+
39+
////
40+
Include titles and alternative text descriptions for images.
41+
Alternative text should provide a textual, complete description of the image as a full sentence.
42+
Images should never be the sole means of conveying information and should only supplement the text.
43+
Avoid screenshots or other images that might quickly go out of date and that create a maintenance burden on documentation.
44+
Provide text equivalents for every diagram, image, or other non-text element. Avoid using images of text instead of actual text.
45+
////
46+
.Image title
47+
image::image-file.png[A textual representation of the essential information conveyed by the image.]
3648
{%- endif %}
3749

3850
[role="_additional-resources"]

templates/procedure.adoc

Lines changed: 19 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,8 @@ Base the file name and the ID on the module title. For example:
44
* ID: [id="proc-doing-procedure-a_{context}"]
55
* Title: = Doing procedure A
66

7-
The ID is an anchor that links to the module. Avoid changing it after the module has been published to ensure existing links are not broken.
7+
The ID is an anchor that links to the module. Avoid changing it after the module has been published to ensure existing links are not broken. The `context` attribute enables module reuse. Every module ID includes {context}, which ensures that the module has a unique ID even if it is reused multiple times in an assembly file.
88

9-
The `context` attribute enables module reuse. Every module ID includes {context}, which ensures that the module has a unique ID even if it is reused multiple times in a guide.
10-
////
11-
12-
////
139
Indicate the module type in one of the following
1410
ways:
1511
Add the prefix proc- or proc_ to the file name.
@@ -20,27 +16,31 @@ Add the following attribute before the module ID:
2016
[id="{{module_id}}_{context}"]
2117
= {{module_title}}
2218
////
23-
Start the title of a procedure module with a verb, such as Creating or Create. See also _Wording of headings_ in _The IBM Style Guide_.
19+
Start the title of a procedure module with a gerund, such as Creating, Installing, or Deploying.
2420
////
2521

2622
{% if examples -%}
27-
Write a short introductory paragraph that provides an overview of the module.
28-
29-
Procedure modules should include the steps that users perform and address user motivation.
23+
Write a short introductory paragraph that provides an overview of the module. The introduction should include what the module will help the user do and why it will be beneficial to the user. Include key words that relate to the module to maximize search engine optimization.
3024
{%- endif %}
3125

3226
.Prerequisites
3327

3428
{% if examples -%}
35-
* A bulleted list of conditions that must be satisfied before the user starts following this module.
36-
* You can also link to other modules or assemblies the user must follow before starting this module.
37-
* Delete the section title and bullets if the module has no prerequisites.
29+
* A bulleted list of conditions that must be satisfied before the user starts the steps in this module.
30+
* Prerequisites can be full sentences or sentence fragments; however, prerequisite list items must be parallel.
31+
32+
////
33+
If you have only one prerequisite, list it as a single bullet point.
34+
Do not write prerequisites in the imperative.
35+
You can include links to more information about the prerequisites.
36+
Delete the .Prerequisites section title and bullets if the module has no prerequisites.
37+
////
3838
{%- endif %}
3939

4040
.Procedure
4141

4242
{% if examples -%}
43-
. Start each step with an active verb.
43+
. Make each step an instruction.
4444

4545
. Include one command or action for each step with the exception of simple follow-step, for example:
4646
.. Do this thing and then select *Next*.
@@ -55,14 +55,17 @@ Delete this section if it does not apply to your module. Provide the user with v
5555
////
5656

5757
{% if examples -%}
58-
. Start each step with an active verb.
58+
. Provide an example of expected command output or a pop-up window that the user receives when the procedure is successful.
59+
60+
. List actions for the user to complete, such as entering a command, to determine the success or failure of the procedure.
61+
62+
. Make each step an instruction.
5963

6064
. Include one command or action per step.
6165

62-
. Use an unnumbered bullet (*) if the procedure includes only one step.
66+
. Use an unnumbered bullet (*) if the verification includes only one step.
6367
{%- endif %}
6468

65-
6669
[role="_additional-resources"]
6770
.Additional resources
6871
////

templates/reference.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ Add the following attribute before the module ID:
2121
= {{module_title}}
2222
////
2323
In the title of a reference module, include nouns that are used in the body text. For example, "Keyboard shortcuts for ___" or "Command options for ___." This helps readers and search engines find the information quickly.
24+
25+
Be sure to include a line break between the title and the module introduction.
2426
////
2527

2628
{% if examples -%}

0 commit comments

Comments
 (0)