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

Commit

Permalink
tweaked base templateset README to reflect new files
Browse files Browse the repository at this point in the history
  • Loading branch information
Cameron Shorter committed Jun 10, 2021
1 parent e3c5fa0 commit 38df940
Showing 1 changed file with 23 additions and 17 deletions.
40 changes: 23 additions & 17 deletions base/README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,34 @@
# What's in the base-template directory

This base-template directory contains templates and guides to be followed by a `doctype` template author. They can also be used by a project's docset owner to select and customize the project's templates.
This base-template directory contains a template-set which is to be copied and customized for each doctype template-set.

**Version:** 0.1
**Version:** 0.2

**Last updated:** February 2021
**Last updated:** June 2021

## How to use the base-template files
As a doctype author, you will be responsible for creating three documents:
## Contributing new templates

**xxx-template:**
* Based on the _base-doctype-template_.
* The doctype's headings, standard text, and specific instructions for each section.
We welcome contributions to The Good Docs Project. Refer to our [contribution page](https://thegooddocsproject.dev/contribute.html) for details.

**xxx-guide-template:**
* Based on the _base-doctype-guide-template_.
* General guidance and background theory related to the _doctype_.
TBD: As of June 2021, a more hands on templateer contributing guide is coming.

**xxx-example:**
* Based on the _doctype-example-guide_.
* An example implementation of the doctype, which explains our fake chronologue project.
## The template-set files
As a doctype author, you will be responsible for creating:

Guidance for filling out these documents are provided as _template author tips_ within the above documents, as well as in the holistic _main-doctype-author-guide_.
**xxx-template (what - structural):**
* Layout of headings and sample text with embedded writing tips.

**xxx-example (what):**
* Filled-in template which describes a fake project.

**xxx-guide (how):**
* Extra tips for each section, explaining how to fill in the section.

**xxx-checklist (how):**
* Checklist to confirm an author has covered everything.

**xxx-theory (why - conceptual):**
* Provides background theory which supports authors making documentation decisions.
* Empowers an author to “think like a tech writer”.

## Contributing new templates

We welcome contributions to The Good Docs Project. Refer to our [contribution page](https://thegooddocsproject.dev/contribute.html) for details.

0 comments on commit 38df940

Please sign in to comment.