Skip to content

Commit fe4b8af

Browse files
committed
issue-126 updated with dnaro comments
1 parent 7c62bb7 commit fe4b8af

5 files changed

+17
-15
lines changed

modular-docs-manual/content/topics/using_text_snippets_or_text_fragments.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@
77
// * ID: [id="my-concept-module-a_{context}"]
88
// * Title: = My concept module A
99

10-
// The ID is used as an anchor for linking to the module. Avoid changing it after the module has been published to ensure existing links are not broken.
10+
// 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.
1111
[id="using_text_snippets_or_text_fragments_{context}"]
12-
// The `context` attribute enables module reuse. Every module's ID includes a variable that sets the context, such as {context}, which ensures that the module has a unique ID even if it is reused multiple times in a guide.
12+
// The `context` attribute enables module reuse. Every module ID includes a variable that sets the context, such as {context}, which ensures that the module has a unique ID even if it is reused multiple times in a guide.
1313
= Text Snippets or Text Fragments (Pseudo-modules)
1414
//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.
1515
//Do not start the title of concept modules with a verb. See also _Wording of headings_ in _The IBM Style Guide_.

modular-docs-manual/files/TEMPLATE_ASSEMBLY_a-collection-of-modules.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ ifdef::context[:parent-context: {context}]
1616
* ID: [id="assembly-my-user-story_{context}"]
1717
* Title: = My user story
1818

19-
The ID is used as an anchor for linking to the module. Avoid changing it after the module has been published to ensure existing links are not broken. Include {context} in the ID so the assembly can be reused.
19+
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. Include {context} in the ID so the assembly can be reused.
2020
////
2121
2222
[id="assembly-my-user-story_{context}"]
@@ -28,7 +28,7 @@ If the assembly covers a task, start the title with a verb in the gerund form, s
2828
:context: assembly-keyword
2929
3030
////
31-
The `context` attribute enables module reuse. Every module's ID includes {context}, which ensures that the module has a unique ID even if it is reused multiple times in a guide.
31+
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.
3232
////
3333
3434
[role="_abstract"]

modular-docs-manual/files/TEMPLATE_CONCEPT_concept-explanation.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,13 @@ Base the file name and the ID on the module title. For example:
1010
////
1111

1212
////
13-
The ID is used as an anchor for linking to the module. Avoid changing it after the module has been published to ensure existing links are not broken.
13+
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.
1414
////
1515

1616
[id="con-my-concept-module-a_{context}"]
1717

1818
////
19-
The `context` attribute enables module reuse. Every module's ID includes {context}, which ensures that the module has a unique ID even if it is reused multiple times in a guide.
19+
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.
2020
////
2121

2222
= My concept module A
@@ -25,7 +25,7 @@ In the title of concept modules, include nouns or noun phrases that are used in
2525
////
2626

2727
[role="_abstract"]
28-
A short introductory paragraph that provides an overview of the module is required.
28+
Provide a short introductory paragraph that gives an overview of the module.
2929
It provides an overview of the module. The `[role="_abstract"]` tag defines the first paragraph of the module for search metadata.
3030

3131
The contents of a concept module give the user descriptions and explanations needed to understand and use a product.

modular-docs-manual/files/TEMPLATE_PROCEDURE_doing-one-procedure.adoc

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,13 @@ Base the file name and the ID on the module title. For example:
88
* ID: [id="doing-procedure-a_{context}"]
99
* Title: = Doing procedure A
1010
////
11-
The ID is used as an anchor for linking to the module. Avoid changing it after the module has been published to ensure existing links are not broken.
11+
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.
1212
////
1313

1414
[id="proc-doing-one-procedure_{context}"]
1515

1616
////
17-
The `context` attribute enables module reuse. Every module's ID includes {context}, which ensures that the module has a unique ID even if it is reused multiple times in a guide.
17+
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.
1818
////
1919

2020
= Doing one procedure
@@ -23,7 +23,7 @@ Start the title of a procedure module with a verb, such as Creating or Create. S
2323
////
2424

2525
[role="_abstract"]
26-
A short introductory paragraph that provides an overview of the module is required. Procedure modules should include both what users will do and why users want to do it.
26+
Provide a short introductory paragraph that gives an overview of the module. Procedure modules should include the steps that users perform and address user motivation.
2727
The `[role="_abstract"]` tag defines the first paragraph of the module for search metadata.
2828

2929
.Prerequisites
@@ -36,13 +36,15 @@ The `[role="_abstract"]` tag defines the first paragraph of the module for searc
3636

3737
. Start each step with an active verb.
3838

39-
. Include one command or action per step.
39+
. Include one command or action for each step with the exception of simple follow-step, for example:
40+
.. Do this thing and then select *Next*.
41+
.. Do this other thing and then select *Next*.
4042

4143
. Use an unnumbered bullet (*) if the procedure includes only one step.
4244

4345
.Verification steps
4446
////
45-
Optional. Delete if not applicable. Provide the user with verification methods for the procedure, such as expected output or commands that can be used to check for success or failure.
47+
Delete this section if it does not apply to your module. Provide the user with verification methods for the procedure, such as expected output or commands that confirm success or failure.
4648
////
4749

4850
. Start each step with an active verb.

modular-docs-manual/files/TEMPLATE_REFERENCE_reference-material.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,20 +8,20 @@ Base the file name and the ID on the module title. For example:
88
* ID: [id="ref-my-reference-a_{context}"]
99
* Title: = My reference A
1010

11-
The ID is used as an anchor for linking to the module. Avoid changing it after the module has been published to ensure existing links are not broken.
11+
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.
1212
////
1313

1414
[id="ref-reference-material_{context}"]
1515
////
16-
The `context` attribute enables module reuse. Every module's ID includes {context}, which ensures that the module has a unique ID even if it is reused multiple times in a guide
16+
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
1717
////
1818
= Reference material
1919
////
2020
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.
2121
////
2222

2323
[role="_abstract"]
24-
A short introductory paragraph that provides an overview of the module is required.
24+
Provide a short introductory paragraph that gives an overview of the module.
2525
The `[role="_abstract"]` tag defines the first paragraph of the module for search metadata.
2626
A reference module provides data that users might want to look up, but do not need to remember.
2727
It has a very strict structure, often in the form of a list or a table.

0 commit comments

Comments
 (0)