search

redhat-documentation / modular-docs

Modular Documentation Project provides guidelines and examples for writing technical documentation using a modular framework.
Creative Commons Attribution Share Alike 4.0 International
82 stars 68 forks source link

issue-200 updated modules sections and templates #208

Closed emmurphy1 closed 1 year ago

Jenny-Anne commented 1 year ago

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.

emmurphy1 commented 1 year ago

@Jenny-Anne let's discuss Limitations at the meeting tomorrow.

mjahoda commented 1 year ago

This is a huge improvement of the procedure guidelines. Thank you for preparing it.