This repository has been archived by the owner on Sep 24, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 171
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updated readme to be in template format. Note, it should be moved up …
…a level out of base/ dir
- Loading branch information
Cameron Shorter
committed
Jun 12, 2021
1 parent
38df940
commit 5ee0019
Showing
1 changed file
with
14 additions
and
23 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,34 +1,25 @@ | ||
# What's in the base-template directory | ||
# {doctype} template set | ||
|
||
This base-template directory contains a template-set which is to be copied and customized for each doctype template-set. | ||
This directory contains a set of files to help authors create good {doctype} files. | ||
|
||
**Version:** 0.2 | ||
|
||
**Last updated:** June 2021 | ||
|
||
## Contributing new templates | ||
## Directory contents | ||
|
||
We welcome contributions to The Good Docs Project. Refer to our [contribution page](https://thegooddocsproject.dev/contribute.html) for details. | ||
* {doctype}-template (what - structural) | ||
* Layout of headings and sample text with embedded writing tips. | ||
|
||
TBD: As of June 2021, a more hands on templateer contributing guide is coming. | ||
* {doctype}-example (what) | ||
* Filled-in template which describes the fake chronologue project. | ||
|
||
## The template-set files | ||
As a doctype author, you will be responsible for creating: | ||
|
||
**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”. | ||
* {doctype}-guide (how) | ||
* Extra tips for each section, explaining how to fill in the section. | ||
|
||
* {doctype}-checklist (how) | ||
* Checklist to confirm an author has covered everything. | ||
|
||
* {doctype}-theory (why - conceptual) | ||
* Provides background theory which supports authors making documentation decisions. | ||
* Empowers an author to “think like a tech writer”. |