Skip to content
This repository has been archived by the owner on Sep 24, 2022. It is now read-only.

Align How-to Guide template with improved quality standard #205

Open
aidanatwork opened this issue Jun 23, 2021 · 1 comment · May be fixed by #265
Open

Align How-to Guide template with improved quality standard #205

aidanatwork opened this issue Jun 23, 2021 · 1 comment · May be fixed by #265
Assignees
Labels
templates Denotes only issues about creating our doc type templates. templates-p1

Comments

@aidanatwork
Copy link
Contributor

aidanatwork commented Jun 23, 2021

Align How-to Guide template with improved quality standard

Description

Doc Type Name: How-to Guide

Directory: https://github.com/thegooddocsproject/templates/tree/dev/how-to

Sub-tasks

  • Create how-to-template.md and write content for it. You may or may not want to re-use content from the files already in the folder.
  • Create how-to-guide.md and write content for it. You may or may not want to re-use content from the files already in the folder.
  • Create how-to-theory.md and write content for it. This is any research and conclusions about best practices that support what you are presenting to the end user in the other files. This can be an empty stub file.

There are some old files already in the folder. After finishing the above sub-tasks, it would be great if you could also either remove the old files or create a new task for someone else to do so.

Helpful Resources

The Divio Documentation System - How-to Guides: https://documentation.divio.com/how-to-guides/

@aidanatwork aidanatwork added templates Denotes only issues about creating our doc type templates. templates-p1 labels Jun 23, 2021
@camerons camerons changed the title Create How-to Guide template Align How-to Guide template with improved quality standard Dec 5, 2021
@gayathri-krishnaswamy gayathri-krishnaswamy self-assigned this Jun 8, 2022
@gayathri-krishnaswamy
Copy link
Contributor

@OphyBoamah and I are working on this template.

@OphyBoamah OphyBoamah linked a pull request Aug 29, 2022 that will close this issue
44 tasks
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
templates Denotes only issues about creating our doc type templates. templates-p1
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants