Template quality checklist

This quality checklist will eventually become a pull request template that every contributor needs to add to pull requests against the templates repository.

Pull request summary

This pull request is for the new how-to template and guide.

Worked on by: The How-to Working group. Mentor: @gayathri-krishnaswamy

Template contributor checklist

IMPORTANT: The next three sections in this checklist should be filled out by the template contributor at the time they submit this request.

NOTE: Pull requests can only be merged when all boxes are checked.

Which issue does this pull request fix or reference?

This pull request:

Resolves: https://github.com/thegooddocsproject/templates/issues/205

Procedural requirements
[x] The template contributor participated in a template working group to create this template.
[x] This template was submitted to the community for feedback.
[x] A template mentor approved this template set to move to the pull request phase.

Template set requirements

[x] Template file is present.
[x] Template guide is present.
[x] Template deep dive is present (optional).
[x] Template example is present (optional).
[x] If the optional template example is not present, open a new issue to track this task in the Chronologue repository, then include the link here.

Template pull request reviewer checklist

IMPORTANT: The rest of the sections in this checklist should only be filled out by authorized Good Docs Project pull request reviewers. If you are the individual template contributor, do not fill out the rest of the fields or check the boxes.

NOTE: Pull requests can only be merged when all boxes are checked.

Mechanics and formatting requirements - PULL REQUEST REVIEWER ONLY

[ ] Check rendered Markdown output to ensure it renders correctly.
[ ] Review the template set to ensure all documents follow the template markdown style guide.
[ ] The template set is free from grammar errors and typos.

Overall usability - PULL REQUEST REVIEWER ONLY

[ ] The scope of the template set is appropriate, meaning it is not too simple or overly complex (i.e. it needs to be expanded or broken into multiple smaller templates).
[ ] The template is complete and comprehensive.
[ ] The template set is well-organized and the contents flow in a logical order.
[ ] The template is well-written and clear.
[ ] The template set provides sufficient guidance about how to fill it in and implement the template in a documentation project.

Template file requirements - PULL REQUEST REVIEWER ONLY

[ ] Check rendered Markdown output to ensure it renders correctly and follows the template markdown style guide.
[ ] The template title is present and is an H1.
[ ] The template includes an introductory comment mentioning the other template resources (such as the guide).
[ ] Embedded writing tips are formatted with {curly brackets}.
[ ] The template is free from grammar errors and typos.
[ ] The scope of the template is appropriate, meaning it is not too simple or overly complex (i.e. it needs to be expanded or broken into multiple smaller templates).
[ ] The template is complete and comprehensive.
[ ] The template is well-organized and the contents flow in a logical order.
[ ] The template is well-written and clear.

Template guide requirements - PULL REQUEST REVIEWER ONLY

[ ] Check rendered Markdown output to ensure it renders correctly and follows the template markdown style guide.
[ ] The template guide title is present and is an H1.
[ ] The template includes an introductory comment pointing them to other template resources.
[ ] Embedded writing tips are formatted with {curly brackets}.
[ ] The template guide is free from grammar errors and typos.
[ ] The template guide includes a "Why do I need this type of document?" section.
[ ] The template guide includes a "Contents of this template" section.
[ ] The contents listed in the "Contents of this template" section mirror the sections in the raw template.
[ ] The template guide includes an implementation checklist (optional).
[ ] The template guide includes additional resources (optional).
[ ] The template guide is well-organized and the contents flow in a logical order.
[ ] The template guide is well-written, clear, and provides sound advice to template users.

Deep dive requirements (optional) - PULL REQUEST REVIEWER ONLY

[ ] Check rendered Markdown output to ensure it renders correctly and follows the template markdown style guide.
[ ] The deep drive title is present and is an H1.
[ ] The deep dive guide provides helpful advice about necessary requirements for writing this type of documentation.
[ ] The template set is well-organized and the contents flow in a logical order.
[ ] The template is well-written and clear.

Template example requirements (optional) - PULL REQUEST REVIEWER ONLY

[ ] Check rendered Markdown output to ensure it renders correctly and follows the template markdown style guide.
[ ] The template example provided is well-written and provides a clear example of how to use the template.

I am not 100% sure how to use github but I would like to ask if an Additional Resources section of Useful Links is required. I have taken the list from the previously shared Google Doc and formatted below. Is this relevant? If not, please ignore. If yes, I'd like to know how to add to the template. Many thanks.

Additional Resources

Bhatti, J., Corleissen, Z.S., Lambourne, J., Nunez, D. And Waterhouse, H. 2021. Docs for Developers: An Engineer’s Field Guide to Technical Writing 1st ed. Edition.

Diátaxis. 2017. A systematic framework for technical documentation authoring. https://diataxis.fr/

Useful links

Current How-to template https://github.com/thegooddocsproject/templates/tree/dev/how-to

Diátaxis. framework https://diataxis.fr/tutorials-how-to/

Quickstart template https://github.com/thegooddocsproject/templates/tree/dev/quickstarts

The Good Docs contributing guide https://github.com/thegooddocsproject/templates/blob/dev/CONTRIBUTING.md

Tutorial template https://github.com/thegooddocsproject/templates/tree/dev/tutorial Sample How-to guides

Anbox Cloud. How to create an application https://anbox-cloud.io/docs/howto/application/create

Charmed Kubeflow. How to install Kubeflow v1.4 https://charmed-kubeflow.io/docs/install

Divio How-to guides https://documentation.divio.com/how-to-guides/

Google Cloud Resource Manager Documentation https://cloud.google.com/resource-manager/docs/how-to

Google Compute Engine documentation https://cloud.google.com/compute/docs/how-to

Google developer documentation style guide/. Procedures. https://developers.google.com/style/procedures

openstack How-to guides https://docs.openstack.org/charm-guide/latest/admin/index.html

The jupyter-book repository! https://jupyterbook.org/en/stable/contribute/intro.html

Ubuntu Core How-to guides https://ubuntu.com/core/docs/how-to

thegooddocsproject / templates

New How-to template #265