Skip to content
This repository was archived by the owner on Feb 25, 2020. It is now read-only.

texts for assumptions, prereqs, knowledge level #9

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions source/3-tutorials/tutorial-guidelines.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,23 @@ title: Tutorials Writing Guidelines

## Assumptions, Prerequisites & Knowledge level

### Assumptions:
Every tutorial starts from with certain assumption what a reader knows / wants to learn / tools that are available.
Try to make these assumptions clear, but do not state the obvious:

* use a clear title

### Toolset/Prereqs:
What is the goal of the tutorial? Anything that is not the goal must be done **before** as to not break the flow of the tutorial. Put sucht things in front of the actual tutorial.

Use:

- list / checklist
- directly link to tool websites

### Knowledge Level:
If you presume a certain level of knowledge you should mention this before the user starts. Nothing is worse than to start but not be able to finish.

## Code

## Mixed media
Expand Down