diff --git a/modular-docs-manual/files/TEMPLATE_ASSEMBLY_a-collection-of-modules.adoc b/modular-docs-manual/files/TEMPLATE_ASSEMBLY_a-collection-of-modules.adoc index e0087c8..6a8a763 100644 --- a/modular-docs-manual/files/TEMPLATE_ASSEMBLY_a-collection-of-modules.adoc +++ b/modular-docs-manual/files/TEMPLATE_ASSEMBLY_a-collection-of-modules.adoc @@ -31,6 +31,7 @@ The `context` attribute enables module reuse. Every module ID includes {context} :context: assembly-keyword +[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. == Prerequisites diff --git a/modular-docs-manual/files/TEMPLATE_CONCEPT_concept-explanation.adoc b/modular-docs-manual/files/TEMPLATE_CONCEPT_concept-explanation.adoc index 2f587e1..ea22c0a 100644 --- a/modular-docs-manual/files/TEMPLATE_CONCEPT_concept-explanation.adoc +++ b/modular-docs-manual/files/TEMPLATE_CONCEPT_concept-explanation.adoc @@ -23,6 +23,7 @@ Be sure to include a line break between the title and the module introduction. 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 or gerund. See also _Wording of headings_ in _IBM Style_. //// +[role="_abstract"] Write a short introductory paragraph that provides an overview of the module. The contents of a concept module give the user descriptions and explanations needed to understand and use a product. diff --git a/modular-docs-manual/files/TEMPLATE_PROCEDURE_doing-one-procedure.adoc b/modular-docs-manual/files/TEMPLATE_PROCEDURE_doing-one-procedure.adoc index f715bbe..33947c5 100644 --- a/modular-docs-manual/files/TEMPLATE_PROCEDURE_doing-one-procedure.adoc +++ b/modular-docs-manual/files/TEMPLATE_PROCEDURE_doing-one-procedure.adoc @@ -24,6 +24,7 @@ Be sure to include a line break between the title and the module introduction. Start the title of a procedure module with a gerund, such as Creating, Installing, or Deploying. //// +[role="_abstract"] Write a short introductory paragraph that provides an overview of the module. The introduction should include what the module will help the user do and why it will be beneficial to the user. Include key words that relate to the module to maximize search engine optimization. .Prerequisites diff --git a/modular-docs-manual/files/TEMPLATE_REFERENCE_reference-material.adoc b/modular-docs-manual/files/TEMPLATE_REFERENCE_reference-material.adoc index 5bcf300..b1f6885 100644 --- a/modular-docs-manual/files/TEMPLATE_REFERENCE_reference-material.adoc +++ b/modular-docs-manual/files/TEMPLATE_REFERENCE_reference-material.adoc @@ -23,6 +23,7 @@ In the title of a reference module, include nouns that are used in the body text on. //// +[role="_abstract"] Write a short introductory paragraph that provides an overview of the module. 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.