search

thegooddocsproject / templates

Templates created by The Good Docs Project - for all your tech writing needs.
https://thegooddocsproject.dev/
Other
680 stars 170 forks source link

What standard headings/sections should we have for the guides/about files? #270

Open heykayla opened 2 years ago

heykayla commented 2 years ago

Should we include standard headings for all of the About files?

For example, we can use the following:

  1. Template overview: Explains what users will see in the template.
  2. Introduction: Introduces the guide and explains what the template is used for.
  3. Template breakdown: Introduces and explains the sections that are in the template.