Skip to content

Commit ea243a0

Browse files
committed
issue-126 updated with oraNod comments
1 parent fce1848 commit ea243a0

File tree

4 files changed

+12
-13
lines changed

4 files changed

+12
-13
lines changed

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
@@ -28,11 +28,11 @@ 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 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 so you can include it multiple times in the same guide.
3232
////
3333
3434
[role="_abstract"]
35-
This paragraph is the assembly introduction. It explains what the user will accomplish by working through the modules in the assembly and sets the context for the user story the assembly is based on. The `[role="_abstract"]` tag defines the first paragraph of the introduction for search metadata.
35+
This paragraph is the assembly introduction. It explains what the user will accomplish by working through the modules in the assembly and sets the context for the user story the assembly is based on. The text that immediately follows the `[role="_abstract"]` tag is used for search metadata.
3636
3737
.Prerequisites
3838

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

Lines changed: 2 additions & 3 deletions
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
[id="con-my-concept-module-a_{context}"]
1717

1818
////
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.
19+
The `context` attribute enables module reuse. Every module ID includes {context}, which ensures that the module has a unique ID so you can include it multiple times in the same guide.
2020
////
2121

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

2727
[role="_abstract"]
28-
Provide a short introductory paragraph that gives an overview of the module.
29-
It provides an overview of the module. The `[role="_abstract"]` tag defines the first paragraph of the module for search metadata.
28+
Write a short introductory paragraph that provides an overview of the module. The text that immediately follows the `[role="_abstract"]` tag is used for search metadata.
3029

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

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

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Base the file name and the ID on the module title. For example:
1414
[id="proc-doing-one-procedure_{context}"]
1515

1616
////
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.
17+
The `context` attribute enables module reuse. Every module ID includes {context}, which ensures that the module has a unique ID so you can include it multiple times in the same guide.
1818
////
1919

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

2525
[role="_abstract"]
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.
27-
The `[role="_abstract"]` tag defines the first paragraph of the module for search metadata.
26+
Write a introductory paragraph that provides an overview of the module. Procedure modules should include the steps that users perform and address user motivation. The text that immediately follows the `[role="_abstract"]` tag is used for search metadata.
2827

2928
.Prerequisites
3029

@@ -49,9 +48,11 @@ Delete this section if it does not apply to your module. Provide the user with v
4948

5049
. Start each step with an active verb.
5150

52-
. Include one command or action per step.
51+
. Include one non-trivial command or action for each step:
52+
.. Do this thing and then click *Next*.
53+
.. Do this other thing.
5354

54-
. Use an unnumbered bullet (*) if the procedure includes only one step.
55+
. Use an unordered list item (*) if the procedure includes only one step.
5556

5657

5758
[role="_additional-resources"]

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

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The ID is an anchor that links to the module. Avoid changing it after the module
1313

1414
[id="ref-reference-material_{context}"]
1515
////
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
16+
The `context` attribute enables module reuse. Every module ID includes {context}, which ensures that the module has a unique ID so you can include it multiple times in the same guide.
1717
////
1818
= Reference material
1919
////
@@ -22,8 +22,7 @@ In the title of a reference module, include nouns that are used in the body text
2222

2323
[role="_abstract"]
2424
Provide a short introductory paragraph that gives an overview of the module.
25-
The `[role="_abstract"]` tag defines the first paragraph of the module for search metadata.
26-
A reference module provides data that users might want to look up, but do not need to remember.
25+
The `[role="_abstract"]` tag defines the first paragraph of the module for search metadata. A reference module provides data that users might want to look up, but do not need to remember.
2726
It has a very strict structure, often in the form of a list or a table.
2827
A well-organized reference module enables users to scan it quickly to find the details they want.
2928
AsciiDoc markup to consider for reference data:

0 commit comments

Comments
 (0)