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

Commit

Permalink
docs(readme): added columns to table
Browse files Browse the repository at this point in the history
closed #77
  • Loading branch information
mgan59 authored Aug 26, 2020
2 parents e36d70e + 4df5617 commit 800e9e8
Showing 1 changed file with 17 additions and 17 deletions.
34 changes: 17 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,21 +8,21 @@ Here we provide tips for using these templates.

The templates are categorised in line with standard [DITA](http://docs.oasis-open.org/dita/dita/v1.3/errata02/os/complete/part3-all-inclusive/archSpec/technicalContent/dita-technicalContent-InformationTypes.html#dita_technicalContent_InformationTypes) documentation types:

**Concept**: Describes how and why things work.
**Concept**: Describes how and why things work.
Concepts are normally written to help the reader understand a technology, prior to using it.

**Task**: Gives specific instructions about how to get something done.
**Task**: Gives specific instructions about how to get something done.
In practice, Tasks tend to have a specific goal and usually consist of a set of numbered steps that the reader can follow to achieve the goal.

**Reference**: Contains structured information or specifications that users need to make a product work.
**Reference**: Contains structured information or specifications that users need to make a product work.
Reference sections should comprehensively catalog data such as functions and their parameters, return codes and error messages.

Our templates follow these documentation types, and you should find that your information naturally fits into them as you write.

## How to use these templates

We like to compare documentation types to aisles in a grocery store.
Each aisle includes related templates, which you can think of as ingredients.
We like to compare documentation types to aisles in a grocery store.
Each aisle includes related templates, which you can think of as ingredients.
Use these ingredients in documentation cookbooks to whip up docs for your readers.

When writing your documentation, it helps to think about the following:
Expand All @@ -33,18 +33,18 @@ When writing your documentation, it helps to think about the following:

## The templates

Templates we currently offer:

| Template name | Documentation type |
| ---------------------- | ------- |
API Project overview | Concept
API Quickstart | Concept, Task
API Reference | Reference
Discussion | Concept
How-to | Task
Tutorial | Concept, Task
General reference entry | Reference
Logging reference | Reference
Current templates:

| Template name | Documentation type | Description |
| ------------- | ------------------ | ----------- |
| API Project overview | Concept | An overview of your API |
| API Quickstart | Concept, Task | Simplest possible method of implementing your API |
| API Reference | Reference | List of references related to your API |
| Discussion | Concept | Longer document giving background or context to a topic |
| How-to | Task | Short series of steps for a particular task |
| Tutorial | Concept, Task | A training document for a product or topic |
| General reference entry | Reference | Specific details about a particular topic |
| Logging reference | Reference | Description of log pipelines |

## The cookbook

Expand Down

0 comments on commit 800e9e8

Please sign in to comment.