issue-126 updated the annotated template files

Author: emmurphy1

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

@@ -8,21 +8,22 @@
 ifdef::context[:parent-context: {context}]
 
 // Base the file name and the ID on the assembly title. For example:
-// * file name: my-assembly-a.adoc
-// * ID: [id="my-assembly-a"]
-// * Title: = My assembly A
-
-// 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.
-[id="a-collection-of-modules"]
-// If the assembly is reused in other assemblies in a guide, include {context} in the ID: [id="a-collection-of-modules_{context}"].
-= A collection of modules
+// * file name: assembly-my-user-story.adoc
+// * ID: [id="assembly-my-user-story_{context}"]
+// * Title: = My user story
+
+// 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:
+[id="assembly-my-user-story_{context}"]
+= My user story
 //If the assembly covers a task, start the title with a verb in the gerund form, such as Creating or Configuring.
 :context: assembly-keyword
 // 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.
 
-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. Can include more than one paragraph. Consider using the information from the user story.
+[role="_abstract"]
+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.
 
 .Prerequisites
+//Prerequisites are optional. Do not include in your assembly has no prerequisites.
 
 * A 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.
@@ -31,15 +32,17 @@ This paragraph is the assembly introduction. It explains what the user will acco
 // 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.
 
 include::modules/TEMPLATE_CONCEPT_explaining_a_concept.adoc[leveloffset=+1]
-// [leveloffset=+1] ensures that when a module starts with a level-1 heading (= Heading), the heading will be interpreted as a level-2 heading (== Heading) in the assembly.
+// [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.
 
-include::modules/TEMPLATE_PROCEDURE_doing_one_procedure.adoc[leveloffset=+1]
+include::modules/TEMPLATE_PROCEDURE_doing_one_procedure.adoc[leveloffset=+2]
+include::modules/TEMPLATE_PROCEDURE_reference-material.adoc[leveloffset=2]
 
+[role="_additional-resources"]
 == Additional resources (or Next steps)
+// An optional bulleted list of links to other material closely related to the contents of the assembly.
 
-* A bulleted list of links to other material closely related to the contents of the assembly, including xref links to other assemblies in your collection.
-* For more details on writing assemblies, see the link:https://github.com/redhat-documentation/modular-docs#modular-documentation-reference-guide[Modular Documentation Reference Guide].
-* Use a consistent system for file names, IDs, and titles. For tips, see _Anchor Names and File Names_ in link:https://github.com/redhat-documentation/modular-docs#modular-documentation-reference-guide[Modular Documentation Reference Guide].
+* link:https://github.com/redhat-documentation/modular-docs#modular-documentation-reference-guide[Modular Documentation Reference Guide]
+* link:https://asciidoctor.org/docs/user-manual/[Asciidoctor User Manual]
 
 // Restore the context to what it was before this assembly.
 ifdef::parent-context[:context: {parent-context}]

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

@@ -3,29 +3,30 @@
 // <List assemblies here, each on a new line>
 
 // Base the file name and the ID on the module title. For example:
-// * file name: my-concept-module-a.adoc
-// * ID: [id="my-concept-module-a_{context}"]
+// * file name: con-my-concept-module-a.adoc
+// * ID: [id="con-my-concept-module-a_{context}"]
 // * Title: = My concept module A
 
 // 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.
-[id="concept-explanation_{context}"]
+[id="con-my-concept-module-a_{context}"]
 // 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.
-= Concept explanation
+= My concept module A
 //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_.
 
-A short introductory paragraph is required for the concept module.
-It will provide an overview of the module.
+[role="_abstract"]
+A short introductory paragraph that provides an overview of the module is required.
+It provides an overview of the module. The `[role="_abstract"]` tag defines the first paragraph of the module for search metadata.
 
 The contents of a concept module give the user descriptions and explanations needed to understand and use a product.
 
 * Look at nouns and noun phrases in related procedure modules and assemblies to find the concepts to explain to users.
 * 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.
 * Do not include any instructions to perform an action, such as executing a command. Action items belong in procedure modules.
 
+[role="_additional-resources"]
 .Additional resources
+// An optional bulleted list of links to other material closely related to the contents of the concept module.
 
-* A bulleted list of links to other material closely related to the contents of the concept module.
-* Currently, modules cannot include xrefs, so you cannot include links to other content in your collection. If you need to link to another assembly, add the xref to the assembly that includes this module.
-* For more details on writing concept modules, see the link:https://github.com/redhat-documentation/modular-docs#modular-documentation-reference-guide[Modular Documentation Reference Guide].
-* Use a consistent system for file names, IDs, and titles. For tips, see _Anchor Names and File Names_ in link:https://github.com/redhat-documentation/modular-docs#modular-documentation-reference-guide[Modular Documentation Reference Guide].
+* link:https://github.com/redhat-documentation/modular-docs#modular-documentation-reference-guide[Modular Documentation Reference Guide]
+* link:https://asciidoctor.org/docs/user-manual/[Asciidoctor User Manual]

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

@@ -3,17 +3,19 @@
 // <List assemblies here, each on a new line>
 
 // Base the file name and the ID on the module title. For example:
-// * file name: doing-procedure-a.adoc
-// * ID: [id="doing-procedure-a"]
+// * file name: proc-doing-procedure-a.adoc
+// * ID: [id="doing-procedure-a_{context}"]
 // * Title: = Doing procedure A
 
 // 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.
-[id="doing-one-procedure_{context}"]
+[id="proc-doing-one-procedure_{context}"]
 // 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.
 = Doing one procedure
 // 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_.
 
-This paragraph is the procedure module introduction: a short description of the procedure.
+[role="_abstract"]
+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.
+The `[role="_abstract"]` tag defines the first paragraph of the module for search metadata.
 
 .Prerequisites
 
@@ -29,12 +31,19 @@ This paragraph is the procedure module introduction: a short description of the
 
 . Use an unnumbered bullet (*) if the procedure includes only one step.
 
-//.Verification steps
-//(Optional) Provide the user with verification method(s) for the procedure, such as expected output or commands that can be used to check for success or failure.
+.Verification steps (Optional, delete if not applicable)
+//(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.
 
+. Start each step with an active verb.
+
+. Include one command or action per step.
+
+. Use an unnumbered bullet (*) if the procedure includes only one step.
+
+
+[role="_additional-resources"]
 .Additional resources
+// An optional bulleted list of links to other material closely related to the contents of the procedure module.
 
-* A bulleted list of links to other material closely related to the contents of the procedure module.
-* Currently, modules cannot include xrefs, so you cannot include links to other content in your collection. If you need to link to another assembly, add the xref to the assembly that includes this module.
-* For more details on writing procedure modules, see the link:https://github.com/redhat-documentation/modular-docs#modular-documentation-reference-guide[Modular Documentation Reference Guide].
-* Use a consistent system for file names, IDs, and titles. For tips, see _Anchor Names and File Names_ in link:https://github.com/redhat-documentation/modular-docs#modular-documentation-reference-guide[Modular Documentation Reference Guide].
+* link:https://github.com/redhat-documentation/modular-docs#modular-documentation-reference-guide[Modular Documentation Reference Guide]
+* link:https://asciidoctor.org/docs/user-manual/[Asciidoctor User Manual]

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

@@ -3,19 +3,19 @@
 // <List assemblies here, each on a new line>
 
 // Base the file name and the ID on the module title. For example:
-// * file name: my-reference-a.adoc
-// * ID: [id="my-reference-a"]
+// * file name: ref-my-reference-a.adoc
+// * ID: [id="ref-my-reference-a_{context}"]
 // * Title: = My reference A
 
 // 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.
-[id="reference-material_{context}"]
+[id="ref-reference-material_{context}"]
 // 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.
 = Reference material
 //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.
 
-A short introductory paragraph is required for the reference module.
-It will provide an overview of the module.
-
+[role="_abstract"]
+A short introductory paragraph that provides an overview of the module is required.
+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.
 It has a very strict structure, often in the form of a list or a table.
 A well-organized reference module enables users to scan it quickly to find the details they want.

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

@@ -1,15 +1,13 @@
 
 ifdef::context[:parent-context: {context}]
 
-
-[id="a-collection-of-modules"]
-
-= A collection of modules
+[id="assembly-my-user-story_{context}"]
+= My user story
 
 :context: assembly-keyword
 
-[role="system:abstract"]
-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="system:abstract"]` tag defines the first paragraph of the introduction for search metadata.
+[role="_abstract"]
+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.
 
 .Prerequisites (optional)
 
@@ -19,10 +17,10 @@ This paragraph is the assembly introduction. It explains what the user will acco
 
 include::modules/TEMPLATE_CONCEPT_explaining_a_concept.adoc[leveloffset=+1]
 
-include::modules/TEMPLATE_PROCEDURE_doing_one_procedure.adoc[leveloffset=+1]
+include::modules/TEMPLATE_PROCEDURE_doing_one_procedure.adoc[leveloffset=+2]
 
-[role="system:additional-resources"]
-== Additional resources
+[role="_additional-resources"]
+== Additional resources (or Next steps)
 // An optional bulleted list of links to other material closely related to the contents of the assembly.
 
 * link:https://github.com/redhat-documentation/modular-docs#modular-documentation-reference-guide[Modular Documentation Reference Guide]

modular-docs-manual/files/templates-without-comments/con-concept-explanation.adoc

@@ -3,17 +3,17 @@
 
 = Concept explanation
 
-[role="system:abstract"]
+[role="_abstract"]
 A short introductory paragraph that provides an overview of the module is required.
-It provides an overview of the module. The `[role="system:abstract"]` tag defines the first paragraph of the module for search metadata.
+It provides an overview of the module. The `[role="_abstract"]` tag defines the first paragraph of the module for search metadata.
 
 The contents of a concept module give the user descriptions and explanations needed to understand and use a product.
 
 * Look at nouns and noun phrases in related procedure modules and assemblies to find the concepts to explain to users.
 * 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.
 * Do not include any instructions to perform an action, such as executing a command. Action items belong in procedure modules.
 
-[role="system:additional-resources"]
+[role="_additional-resources"]
 .Additional resources
 // An optional bulleted list of links to other material closely related to the contents of the concept module.
 

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

@@ -3,9 +3,9 @@
 
 = Doing one procedure
 
-[role="system:abstract"]
+[role="_abstract"]
 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.
-The `[role="system:abstract"]` tag defines the first paragraph of the module for search metadata.
+The `[role="_abstract"]` tag defines the first paragraph of the module for search metadata.
 
 
 .Prerequisites (optional)
@@ -22,7 +22,15 @@ The `[role="system:abstract"]` tag defines the first paragraph of the module for
 
 . Use an unnumbered bullet (*) if the procedure includes only one step.
 
-[role="system:additional-resources"]
+.Verification steps (Optional, delete if not applicable)
+
+. Start each step with an active verb.
+
+. Include one command or action per step.
+
+. Use an unnumbered bullet (*) if the procedure includes only one step.
+
+[role="_additional-resources"]
 .Additional resources
 // An optional bulleted list of links to other material closely related to the contents of the procedure module.
 

modular-docs-manual/files/templates-without-comments/ref-reference-material.adoc

@@ -2,9 +2,9 @@
 
 = Reference material
 
-[role="system:abstract"]
+[role="_abstract"]
 A short introductory paragraph that provides an overview of the module is required.
-The `[role="system:abstract"]` tag defines the first paragraph of the module for search metadata.
+The `[role="_abstract"]` tag defines the first paragraph of the module for search metadata.
 
 A reference module provide data that users might want to look up. A reference module does not contain procedures or detailed concept information. It has a very strict structure, often in the form of a list or a table. A well-organized reference module enables users to scan it quickly to find the details they want.
 AsciiDoc markup to consider for reference data: