Skip to content

Added missing tag in all templates-[role=_abstract] #243

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mjahoda merged 1 commit into from
Sep 8, 2025
Merged

Added missing tag in all templates-[role=_abstract] #243

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions modular-docs-manual/files/TEMPLATE_ASSEMBLY_a-collection-of-modules.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions modular-docs-manual/files/TEMPLATE_CONCEPT_concept-explanation.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
1 change: 1 addition & 0 deletions modular-docs-manual/files/TEMPLATE_PROCEDURE_doing-one-procedure.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions modular-docs-manual/files/TEMPLATE_REFERENCE_reference-material.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down