Skip to content

Commit dc46d04

Browse files
authored
Merge pull request #243 from dubewarsagar/main
Added missing tag in all templates-[role=_abstract]
2 parents e418ef7 + 26c925e commit dc46d04

File tree

4 files changed

+4
-0
lines changed

4 files changed

+4
-0
lines changed

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ The `context` attribute enables module reuse. Every module ID includes {context}
3131
3232
:context: assembly-keyword
3333
34+
[role="_abstract"]
3435
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.
3536
3637
== Prerequisites

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ Be sure to include a line break between the title and the module introduction.
2323
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_.
2424
////
2525
26+
[role="_abstract"]
2627
Write a short introductory paragraph that provides an overview of the module.
2728
2829
The contents of a concept module give the user descriptions and explanations needed to understand and use a product.

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ Be sure to include a line break between the title and the module introduction.
2424
Start the title of a procedure module with a gerund, such as Creating, Installing, or Deploying.
2525
////
2626
27+
[role="_abstract"]
2728
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.
2829
2930
.Prerequisites

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ In the title of a reference module, include nouns that are used in the body text
2323
on.
2424
////
2525
26+
[role="_abstract"]
2627
Write a short introductory paragraph that provides an overview of the module.
2728
2829
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.

0 commit comments

Comments
 (0)