Conversation
IanFrangs
left a comment
There was a problem hiding this comment.
I have read through all of the proposed changes and they all look good to me, I do not see anything that I can comment on or correct.
|
Hi @emmurphy1, While we're updating the parts in a procedure module, can we consider adding an optional .Limitations section to the procedure template (or at least a guideline about optional extra sections)? I was going to use a [discrete] heading for a Limitations section but I've seen a good few examples of a .Limitations heading being used in our docs repo instead (before the .Procedure section, and in some case before a .Prerequisites section). There are also examples of a .Troubleshooting section after the .Procedure section or after the .Verification section. |
|
@Jenny-Anne let's discuss Limitations at the meeting tomorrow. |
modular-docs-manual/content/topics/creating_procedure_modules.adoc
Outdated
Show resolved
Hide resolved
modular-docs-manual/content/topics/creating_procedure_modules.adoc
Outdated
Show resolved
Hide resolved
|
|
||
| * Limitations | ||
| * Prerequisites | ||
| * Verification or Verification steps |
modular-docs-manual/content/topics/creating_procedure_modules.adoc
Outdated
Show resolved
Hide resolved
| .Procedure prerequisites | ||
| This section is optional. Prerequisites are a bulleted list of conditions that must be satisfied before the user starts the procedure. Use a bulleted list for prerequisites and the plural heading *Prerequisites*, even if you only have a single prerequisite. | ||
| .Limitations | ||
| This section is optional and not used often. If there are any limitations that the affect the procedure, list them in this section. |
There was a problem hiding this comment.
delete the first "the" in "any limitations that the affect the procedure"
modular-docs-manual/content/topics/creating_procedure_modules.adoc
Outdated
Show resolved
Hide resolved
modular-docs-manual/content/topics/creating_procedure_modules.adoc
Outdated
Show resolved
Hide resolved
modular-docs-manual/content/topics/creating_procedure_modules.adoc
Outdated
Show resolved
Hide resolved
|
This is a huge improvement of the procedure guidelines. Thank you for preparing it. |
No description provided.