Skip to content

Add additional files for API Reference template

The API reference template is missing the following template file deliverables:

  • Template resources - Includes the resources consulted during the research phase of creating the template. Also includes high quality examples of that content type that served as inspiration for the template.
  • Template process - Explains best practices for researching, writing, and maintaining this content type.

Templateers who work on this issue will need to create these template file deliverables. See the Template deliverables guide for guidance about these files. You can also look at examples of other templates in the repository to see examples of each template file. Be aware that some templates might be missing some files.

Link to Google Doc drafts

Our project composes rough draft of templates in Google Docs that are owned and maintained by the project leads. The Good Docs Project owns these files so that we can maintain our project archive and history. With that in mind, the project has pre-generated Google Doc files for you to use as you are researching and drafting your template project. These files include a starting point for the structure of each file that should help you as you draft the documents:

Bookmark these drafts and use them as you work on your project.

See the next section for more information about these files.

Definition of done

A template project is considered complete when the missing template file deliverables have been added to the template.

Template writing phases

Although it is optional, we recommend working these missing files through each template writing phase.

See the Templates CONTRIBUTING guide for guidance about these phases. You can also receive help from your working group leads and members about how to move your issue through each phase.

Required template deliverables

To be considered complete, a template project must have the missing files.

Want to work on this template?

Great! Make sure you follow our contributing guidelines:

  1. Check that the template is unassigned. If it is assigned, you might be able to work with the current assignee as a paired writer.
  2. Join The Good Docs Project by attending a Welcome Wagon meeting. You will get access to The Good Docs Project Slack workspace after scheduling or attending this meeting.
  3. Read the Templates CONTRIBUTING guide.
  4. You are strongly encouraged to join one of the working groups to get valuable support from the community such as mentorship, Git training, and helpful feedback as you contribute to your first template.
  5. Request access to the templates repository by joining the #tech-requests channel in Slack and posting a request.
  6. Assign yourself to an issue for the template that you want to work on.
  7. Add the Template phase:: Research label to the issue.
  8. Attend your template working group regularly to receive support and resources for your project.
Edited by Alyssa Rock