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

Align Reference template with new quality expectations #198

Open
aidanatwork opened this issue May 19, 2021 · 0 comments
Open

Align Reference template with new quality expectations #198

aidanatwork opened this issue May 19, 2021 · 0 comments
Labels
templates Denotes only issues about creating our doc type templates. templates-p1

Comments

@aidanatwork
Copy link
Contributor

aidanatwork commented May 19, 2021

Align Reference template with new quality expectations

Description

Doc Type Name: Reference

Directory: https://github.com/thegooddocsproject/templates/tree/master/reference

Sub-tasks

  1. Create reference-template.md and write content for it
  2. Create reference-guide.md and write content for it
  3. Create reference-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.

We already have an attempt at template files in this directory, but they need to be renamed to match our naming convention. Extraneous files also need to be deleted. Should be general enough to encompass both API reference pages and other types of reference pages.

Helpful Resources

https://documentation.divio.com/reference/

@aidanatwork aidanatwork added templates Denotes only issues about creating our doc type templates. templates-p1 labels May 19, 2021
@aidanatwork aidanatwork self-assigned this May 19, 2021
@camerons camerons changed the title Create Reference template Align Reference template with new quality expectations Dec 5, 2021
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

No branches or pull requests

1 participant