This repository was archived by the owner on Feb 25, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 6
Add structure section #8
Open
raquel-campuzano
wants to merge
2
commits into
algolia:master
Choose a base branch
from
raquel-campuzano:structure-guidelines
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 |
---|---|---|
|
@@ -6,6 +6,61 @@ title: Tutorials Writing Guidelines | |
|
||
## Structure | ||
|
||
Conciseness, clarity and order are three of the key conditions that a tutorial should accomplish. To make sure that your tutorial meets these requirements, you need to create a strong and step-through structure before writing the tutorial. And keep the same structure in all the tutorials you produce in order to make your documentation consistent. | ||
|
||
Here is an example / template you can use as an inspiration to create your own tutorials structure: | ||
|
||
### Introduction | ||
|
||
The introduction should be a general overview of what the user can expect of the tutorial that it is about to read. It should contains, at least, the following content: | ||
|
||
* A short definition about the product or topic covered by the tutorial. | ||
* Provide some context about the use scenario of the product or topic of the tutorial. | ||
* Specify the goal of the tutorial and the results that users will obtain following it. | ||
* Mention what users will learn using the tutorial. | ||
* Explain briefly how will be the processes explained: with an example application, using a specific tool, etc. | ||
|
||
### Assumptions and Prerequisites | ||
|
||
Depending of the complexity of the topic you will cover in the tutorial, you need to provide information about what users need to know and have installed in their systems before following the instructions to achieve successfully the goal of the tutorial. | ||
|
||
Add a list of knowledge assumptions and system requisites supplying links to learn the required topics or install the needed resources. Find below an example of a prerequisites list: | ||
|
||
> This guide makes the following assumptions: | ||
> * You have a Docker environment installed and configured. [Learn more about installing Docker](https://docs.docker.com/engine/installation/). | ||
> * You have a Docker Hub account. [Register for a free account](https://hub.docker.com/). | ||
> * You have a basic understanding of how containers work. Learn more about containers in [our YouTube video](https://www.youtube.com/watch?v=Pb1bgI59dF0), on [Wikipedia](https://en.wikipedia.org/wiki/Operating-system-level_virtualization) and on [ZDNet](http://www.zdnet.com/article/containers-fundamental-to-the-evolution-of-the-cloud/). | ||
|
||
### Overview steps (optional) | ||
|
||
To make easier a first contact with the flow that users will follow in the guide you can optionally add a subsection with the list of the steps / actions they will perform. These can be linkable so users can skip those steps that they have actually done. | ||
|
||
### Instructions | ||
|
||
It is very important to chunk the instructions in different steps or sections, that way, the tutorial is more readable and easy to follow. | ||
|
||
* Title: the title of each step needs to be clear and concise, preferably written in active voice. It should describe accurately the action that is explained in the section. | ||
* Instructions / Steps: | ||
* Each content block or section should describe just one action. Write the actions in steps, shown as an ordered list. Never more than 8 steps in the same section. If the section needs more than 8 steps to achieve the goal, consider to split it in two sections. | ||
* Place a sentence at the beginning of the section that resumes the goal of the current step and how it will be explained. Then, proceed with the instructions creating different steps. | ||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Also add results? Depends on how difficult things are, i guess. Could be a screenshot of the result or a very short description. |
||
### Caveats | ||
|
||
A good way to warn users about expected errors or known issues they may find following the tutorial is to write a "caveat" section at the end of the tutorial. It is a good way to clarify some points shown in the tutorial and help users to understand and solve them by themselves. [Check this Algolia's caveats section to have a live example](https://www.algolia.com/doc/tutorials/indexing/3rd-party-service/firebase-algolia/?language=swift#caveats). | ||
|
||
### Resources | ||
|
||
Point users to both external useful resources and internal documentation references that may be useful to understand and deepen the concepts they just learn in the tutorial. These resources can be: | ||
|
||
* Links to official documentation. | ||
* Links to internal related tutorials and how-to guides. | ||
* Links to Git Hub repositories. | ||
* Links to blog posts. | ||
* Links to use cases. | ||
* Demos and video tutorials. | ||
|
||
In the same line, you also can include a **What's next** section which includes links to more advanced tutorials that help to complete the product user journey. | ||
|
||
## General writing guidelines | ||
|
||
## Assumptions, Prerequisites & Knowledge level | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There is anouther Assumptions and Prereqs section. Merge the content?