Skip to content

Commit b7b9778

Browse files
author
“Emily
committed
template-update updated with reviewer comments
1 parent 97cacca commit b7b9778

File tree

4 files changed

+9
-13
lines changed

4 files changed

+9
-13
lines changed

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

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

99

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

@@ -20,7 +20,6 @@ Indicates that this file is an assembly:
2020

2121
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.
2222
////
23-
2423
[id="assembly-my-user-story_{context}"]
2524
= My user story
2625
@@ -64,7 +63,7 @@ include::modules/TEMPLATE_PROCEDURE_reference-material.adoc[leveloffset=+2]
6463
== Next steps
6564
6665
* This section is optional.
67-
* Provide information about the next steps the user might want to take. T
66+
* Provide information about the next steps the user might want to take.
6867
* This section can include text and links.
6968
7069
// If the last module included in your assembly contains an Additional resources section as well, check the appearance of the rendered assembly. If the two Additional resources sections might be confusing for a reader, consider consolidating their content and removing one of them.

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

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

55
:_mod-docs-content-type: CONCEPT
@@ -16,10 +16,9 @@ The `context` attribute enables module reuse. Every module ID includes {context}
1616
////
1717

1818
[id="my-concept-module-a_{context}"]
19-
2019
= My concept module A
2120
////
22-
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 _The IBM Style Guide_.
21+
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_.
2322
2423
Be sure to include a line break between the title and the module introduction.
2524
////
@@ -34,8 +33,8 @@ The contents of a concept module give the user descriptions and explanations nee
3433

3534

3635
////
37-
Do not include level three headings (===).
38-
Include titles and alternative text descriptions for images and enclose the descriptions in quotation marks (""). Alternative text should provide a textual, complete description of the image as a full sentence.
36+
Do not include third-level headings (===).
37+
Include titles and alternative text descriptions for images and enclose the descriptions in straight quotation marks (""). Alternative text should provide a textual, complete description of the image as a full sentence.
3938
Images should never be the sole means of conveying information and should only supplement the text.
4039
Avoid screenshots or other images that might quickly go out of date and that create a maintenance burden on documentation. Provide text equivalents for every diagram, image, or other non-text element. Avoid using images of text instead of actual text.
4140
////

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

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

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

66
:_mod-docs-content-type: PROCEDURE
@@ -17,7 +17,6 @@ The `context` attribute enables module reuse. Every module ID includes {context}
1717
////
1818

1919
[id="doing-procedure-a_{context}"]
20-
2120
= Doing procedure A
2221
////
2322
Start the title of a procedure module with a gerund, such as Creating, Installing, or Deploying.
@@ -38,7 +37,7 @@ Write a short introductory paragraph that provides an overview of the module. Th
3837
.. Do this other thing, and this other thing, and then select *Next*.
3938
. Use an unnumbered bullet (*) if the procedure includes only one step.
4039
+
41-
NOTE: You can add text, tables, code examples, images, and other items to a step. However, these items must be connected to the step the a plus sign (+). Any items under the .Procedure heading and before one of the following approved headings that are not connected to the last step with a plus sign cannot be converted to DITA.
40+
NOTE: You can add text, tables, code examples, images, and other items to a step. However, these items must be connected to the step with a plus sign (+). Any items under the .Procedure heading and before one of the following approved headings that are not connected to the last step with a plus sign cannot be converted to DITA.
4241

4342
////
4443
Only the following block headings can be reliably mapped to DITA: Prerequisites, Procedure, Verification, Troubleshooting, Troubleshooting steps, Next steps, Next step, Additional resources. They must appear in this order and, with the exception of Additional resources, are only allowed in a procedure module. You can also use block headings in figure, table, and example titles.

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

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

@@ -15,7 +15,6 @@ The `context` attribute enables module reuse. Every module ID includes {context}
1515
////
1616

1717
[id="reference-material_{context}"]
18-
1918
= Reference material
2019
////
2120
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.

0 commit comments

Comments
 (0)