Skip to content

Commit 63b6c6a

Browse files
committed
issue-126
1 parent ea243a0 commit 63b6c6a

File tree

2 files changed

+6
-9
lines changed

2 files changed

+6
-9
lines changed

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

Lines changed: 4 additions & 6 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 so you can include it multiple times in the same 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-
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.
26+
Write a short 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.
2727

2828
.Prerequisites
2929

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

4949
. Start each step with an active verb.
5050

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

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

5755

5856
[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,16 +13,15 @@ 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 so you can include it multiple times in the same 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-
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. A reference module provides data that users might want to look up, but do not need to remember.
24+
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. A reference module provides data that users might want to look up, but do not need to remember.
2625
It has a very strict structure, often in the form of a list or a table.
2726
A well-organized reference module enables users to scan it quickly to find the details they want.
2827
AsciiDoc markup to consider for reference data:

0 commit comments

Comments
 (0)