Skip to content

Commit 88a5c5c

Browse files
author
“Emily
committed
template-update updated with JH comments
1 parent b7b9778 commit 88a5c5c

File tree

4 files changed

+23
-26
lines changed

4 files changed

+23
-26
lines changed

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

Lines changed: 10 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ ifdef::context[:parent-context: {context}]
88

99

1010
////
11-
Metadata attribute that will help enable correct parsing and conversion to the appropriate DITA element.
11+
Metadata attribute that will help enable correct parsing and conversion to the appropriate DITA topic type.
1212
////
1313
:_mod-docs-content-type: ASSEMBLY
1414

@@ -18,23 +18,19 @@ Metadata attribute that will help enable correct parsing and conversion to the a
1818
* ID: [id="assembly-my-user-story_{context}"]
1919
* Title: = My user story
2020

21-
The ID is an anchor that links 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.
22-
////
23-
[id="assembly-my-user-story_{context}"]
24-
= My user story
21+
ID is a unique identifier that can be used to reference this assembly. 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.
2522

26-
////
2723
Be sure to include a line break between the title and the :context: variable and the :context: variable and the assembly introduction.
28-
2924
If the assembly covers a task, start the title with a verb in the gerund form, such as Creating or Configuring.
3025
////
31-
32-
:context: assembly-keyword
33-
26+
[id="assembly-my-user-story_{context}"]
27+
= My user story
3428
////
3529
The `context` attribute enables module reuse. Every module ID includes {context}, which ensures that the module has a unique ID so you can include it multiple times in the same guide.
3630
////
3731
32+
:context: assembly-keyword
33+
3834
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.
3935
4036
== Prerequisites
@@ -47,16 +43,15 @@ This paragraph is the assembly introduction. It explains what the user will acco
4743
4844
////
4945
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.
50-
////
51-
52-
include::modules/TEMPLATE_CONCEPT_explaining_a_concept.adoc[leveloffset=+1]
5346

54-
////
5547
[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.
48+
49+
Add a blank line after each 'include::' statement.
5650
////
5751
52+
include::modules/TEMPLATE_CONCEPT_explaining_a_concept.adoc[leveloffset=+1]
53+
5854
include::modules/TEMPLATE_PROCEDURE_doing_one_procedure.adoc[leveloffset=+2]
59-
// Add a blank line after each 'include::' statement.
6055
6156
include::modules/TEMPLATE_PROCEDURE_reference-material.adoc[leveloffset=+2]
6257

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
////
2-
Metadata attribute that will help enable correct parsing and conversion to the appropriate DITA element.
2+
Metadata attribute that will help enable correct parsing and conversion to the appropriate DITA topic type.
33
////
44

55
:_mod-docs-content-type: CONCEPT
@@ -10,17 +10,17 @@ Base the file name and the ID on the module title. For example:
1010
* ID: [id="my-concept-module-a_{context}"]
1111
* Title: = My concept module A
1212

13-
The ID is an anchor that links to the module. Avoid changing it after the module has been published to ensure existing links are not broken.
13+
ID is a unique identifier that can be used to reference this module. Avoid changing it after the module has been published to ensure existing links are not broken.
1414

1515
The `context` attribute enables module reuse. Every module ID includes {context}, which ensures that the module has a unique ID so you can include it multiple times in the same guide.
16+
17+
Be sure to include a line break between the title and the module introduction.
1618
////
1719
1820
[id="my-concept-module-a_{context}"]
1921
= My concept module A
2022
////
2123
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_.
22-
23-
Be sure to include a line break between the title and the module introduction.
2424
////
2525
2626
Write a short introductory paragraph that provides an overview of the module.

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

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11

22
////
3-
Metadata attribute that will help enable correct parsing and conversion to the appropriate DITA element.
3+
Metadata attribute that will help enable correct parsing and conversion to the appropriate DITA topic type.
44
////
55

66
:_mod-docs-content-type: PROCEDURE
@@ -11,16 +11,17 @@ Base the file name and the ID on the module title. For example:
1111
* ID: [id="doing-procedure-a_{context}"]
1212
* Title: = Doing procedure A
1313

14-
The ID is an anchor that links to the module. Avoid changing it after the module has been published to ensure existing links are not broken.
14+
ID is a unique identifier that can be used to reference this module. Avoid changing it after the module has been published to ensure existing links are not broken.
1515

1616
The `context` attribute enables module reuse. Every module ID includes {context}, which ensures that the module has a unique ID so you can include it multiple times in the same guide.
17+
18+
Be sure to include a line break between the title and the module introduction.
1719
////
1820
1921
[id="doing-procedure-a_{context}"]
2022
= Doing procedure A
2123
////
2224
Start the title of a procedure module with a gerund, such as Creating, Installing, or Deploying.
23-
Be sure to include a line break between the title and the module introduction.
2425
////
2526
2627
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.

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

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
////
2-
Metadata attribute that will help enable correct parsing and conversion to the appropriate DITA element.
2+
Metadata attribute that will help enable correct parsing and conversion to the appropriate DITA topic type.
33
////
44
:_mod-docs-content-type: REFERENCE
55

@@ -9,17 +9,18 @@ Base the file name and the ID on the module title. For example:
99
* ID: [id="my-reference-a_{context}"]
1010
* Title: = My reference A
1111

12-
The ID is an anchor that links to the module. Avoid changing it after the module has been published to ensure existing links are not broken.
12+
ID is a unique identifier that can be used to reference this module. Avoid changing it after the module has been published to ensure existing links are not broken.
1313

1414
The `context` attribute enables module reuse. Every module ID includes {context}, which ensures that the module has a unique ID so you can include it multiple times in the same guide.
15+
16+
Be sure to include a line break between the title and the module introduction.
1517
////
1618
1719
[id="reference-material_{context}"]
1820
= Reference material
1921
////
2022
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.
21-
22-
Be sure to include a line break between the title and the module introduction.
23+
on.
2324
////
2425
2526
Write a short introductory paragraph that provides an overview of the module.

0 commit comments

Comments
 (0)