You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: modular-docs-manual/files/TEMPLATE_PROCEDURE_doing-one-procedure.adoc
+2-18Lines changed: 2 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -33,7 +33,7 @@ Write a short introductory paragraph that provides an overview of the module. Th
33
33
34
34
.Procedure
35
35
. Make each step an instruction.
36
-
. Include one imperative sentences for each step, for example:
36
+
. Include one imperative sentence for each step, for example:
37
37
.. Do this thing and then select *Next*.
38
38
.. Do this other thing, and this other thing, and then select *Next*.
39
39
. Use an unnumbered bullet (*) if the procedure includes only one step.
@@ -44,7 +44,6 @@ NOTE: You can add text, tables, code examples, images, and other items to a step
44
44
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.
45
45
////
46
46
47
-
48
47
.Verification
49
48
Delete this section if it does not apply to your module. Provide the user with verification methods for the procedure, such as expected output or commands that confirm success or failure.
50
49
@@ -59,23 +58,8 @@ Delete this section if it does not apply to your module. Provide the user with t
59
58
* Make each step an instruction.
60
59
* Use an unnumbered bullet (*) if the troubleshooting includes only one step.
61
60
62
-
63
61
.Next steps
64
-
* Provide a bulleted list of links that contain instructions that might be useful to the user after they complete this procedure.
65
-
* Use an unnumbered bullet (*) if the list includes only one step.
66
-
67
-
Delete this section if it does not apply to your module. Provide the user with verification methods for the procedure, such as expected output or commands that confirm success or failure.
68
-
69
-
* Provide an example of expected command output or a pop-up window that the user receives when the procedure is successful.
70
-
* List actions for the user to complete, such as entering a command, to determine the success or failure of the procedure.
71
-
* Make each step an instruction.
72
-
* Include one command or action per step.
73
-
* Use an unnumbered bullet (*) if the verification includes only one step.
74
-
75
-
[role="_additional-resources"]
76
-
.Next steps
77
-
78
-
* This section is optional.
62
+
* Delete this section if it does not apply to your module.
79
63
* Provide a bulleted list of links that contain instructions that might be useful to the user after they complete this procedure.
80
64
* Use an unnumbered bullet (*) if the list includes only one step.
Copy file name to clipboardExpand all lines: modular-docs-manual/files/TEMPLATE_REFERENCE_reference-material.adoc
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,7 +32,7 @@ AsciiDoc markup to consider for reference data:
32
32
.Unordered list
33
33
* For more details on writing reference modules, see the link:https://github.com/redhat-documentation/modular-docs#modular-documentation-reference-guide[Modular Documentation Reference Guide].
34
34
* Use a consistent system for file names, IDs, and titles.
35
-
For tips, see _Anchor Names and File Names_ in link:https://github.com/redhat-documentation/modular-docs#modular-documentation-reference-guide[Modular Documentation Reference Guide].
35
+
For tips, see _File names and anchors_ in link:https://github.com/redhat-documentation/modular-docs#modular-documentation-reference-guide[Modular Documentation Reference Guide].
0 commit comments