Skip to content

Commit f17ed38

Browse files
committed
issue-126 updated prerequisites
1 parent 80af607 commit f17ed38

File tree

4 files changed

+16
-17
lines changed

4 files changed

+16
-17
lines changed

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

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,10 @@ ifdef::context[:parent-context: {context}]
2323
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.
2424

2525
.Prerequisites
26-
//Prerequisites are optional. Do not include in your assembly has no prerequisites.
26+
//Prerequisites are optional. Delete if your assembly has no prerequisites.
2727

28-
* A bulleted list of conditions that must be satisfied before the user starts following this assembly.
29-
* You can also link to other modules or assemblies the user must follow before starting this assembly.
30-
* Delete the section title and bullets if the assembly has no prerequisites.
28+
* X is installed. For information about installing X, see <link>.
29+
* You can log in to X with administrator privileges.
3130

3231
// The following include statements pull in the module files that comprise the assembly. Include any combination of concept, procedure, or reference modules required to cover the user story. You can also include other assemblies.
3332

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,10 @@ A short introductory paragraph that provides an overview of the module is requir
1818
The `[role="_abstract"]` tag defines the first paragraph of the module for search metadata.
1919

2020
.Prerequisites
21+
//Prerequisites are optional. Delete if your assembly has no prerequisites.
2122

22-
* A bulleted list of conditions that must be satisfied before the user starts following this module.
23-
* You can also link to other modules or assemblies the user must follow before starting this module.
24-
* Delete the section title and bullets if the module has no prerequisites.
23+
* X is installed. For information about installing X, see <link>.
24+
* You can log in to X with administrator privileges.
2525

2626
.Procedure
2727

@@ -31,8 +31,8 @@ The `[role="_abstract"]` tag defines the first paragraph of the module for searc
3131

3232
. Use an unnumbered bullet (*) if the procedure includes only one step.
3333

34-
.Verification steps (Optional, delete if not applicable)
35-
//(Optional) 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.
34+
.Verification steps
35+
//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.
3636

3737
. Start each step with an active verb.
3838

modular-docs-manual/files/templates-without-comments/assembly-a-collection-of-modules.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ ifdef::context[:parent-context: {context}]
99
[role="_abstract"]
1010
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.
1111

12-
.Prerequisites (optional)
12+
.Prerequisites
13+
// An optional bulleted list of conditions that must be satisfied before the user starts following this assembly.You can also link to other modules or assemblies the user must follow before starting this assembly. Delete the section title and bullets if the assembly has no prerequisites.
1314

14-
* A bulleted list of conditions that must be satisfied before the user starts following this assembly.
15-
* You can also link to other modules or assemblies the user must follow before starting this assembly.
16-
* Delete the section title and bullets if the assembly has no prerequisites.
15+
* X is installed. For information about installing X, see <link>.
16+
* You can log in to X with administrator privileges
1717

1818
include::modules/TEMPLATE_CONCEPT_explaining_a_concept.adoc[leveloffset=+1]
1919

modular-docs-manual/files/templates-without-comments/proc-doing-one-procedure.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@ A short introductory paragraph that provides an overview of the module is requir
88
The `[role="_abstract"]` tag defines the first paragraph of the module for search metadata.
99

1010

11-
.Prerequisites (optional)
11+
.Prerequisites
12+
//Prerequisites are optional. Delete if your assembly has no prerequisites.
1213

13-
* A bulleted list of conditions that must be satisfied before the user starts following this assembly.
14-
* You can also link to other modules or assemblies the user must follow before starting this assembly.
15-
* Delete the section title and bullets if the assembly has no prerequisites.
14+
* X is installed. For information about installing X, see <link>.
15+
* You can log in to X with administrator privileges.
1616

1717
.Procedure
1818

0 commit comments

Comments
 (0)