diff --git a/modular-docs-manual/content/topics/module_guidelines-procedure.adoc b/modular-docs-manual/content/topics/module_guidelines-procedure.adoc index d2c1784..1ea4b44 100644 --- a/modular-docs-manual/content/topics/module_guidelines-procedure.adoc +++ b/modular-docs-manual/content/topics/module_guidelines-procedure.adoc @@ -32,12 +32,14 @@ The procedure consists of one or more steps required to complete the procedure. For single-step procedures, use an unnumbered bullet instead of a numbered list. +NOTE: Not all numbered lists in documentation are procedures. You can also use numbered lists in any module type for non-procedural sequences, such as a process flow of system actions. + [discrete] -== Procedure verification steps +== Procedure Verification This section is optional. Provide the user with one or more steps to verify that the procedure provided the intended outcome. This may consist of: -- An example of expected command output or 'pop-up' window the user should receive when the procedure is successful. -- An 'action' (or 'actions') for the user, such as running a command, to determine the success or failure of the procedure. +* An example of expected command output or pop-up window the user should receive when the procedure is successful +* An action (or actions) for the user, such as running a command, to determine the success or failure of the procedure [discrete] == Procedure Additional Resources diff --git a/modular-docs-manual/files/TEMPLATE_PROCEDURE_doing-one-procedure.adoc b/modular-docs-manual/files/TEMPLATE_PROCEDURE_doing-one-procedure.adoc index 2a20f62..f073740 100644 --- a/modular-docs-manual/files/TEMPLATE_PROCEDURE_doing-one-procedure.adoc +++ b/modular-docs-manual/files/TEMPLATE_PROCEDURE_doing-one-procedure.adoc @@ -41,7 +41,7 @@ Write a short introductory paragraph that provides an overview of the module. Pr . Use an unnumbered bullet (*) if the procedure includes only one step. -.Verification steps +.Verification //// 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. ////