diff options
| author | Marcia Ramos <virtua.creative@gmail.com> | 2017-03-16 16:45:44 -0300 |
|---|---|---|
| committer | Marcia Ramos <virtua.creative@gmail.com> | 2017-03-16 16:45:44 -0300 |
| commit | 60a09846afafe9f8b8888755892103c7b86e0478 (patch) | |
| tree | 8ffd82639048f9b320c8d697d9be79c79099928f /doc/development | |
| parent | 2edd3c0fba800006dd4bd9c742bfcc095d8b6877 (diff) | |
| download | gitlab-ce-60a09846afafe9f8b8888755892103c7b86e0478.tar.gz | |
add distinction between guide and tutorial
Diffstat (limited to 'doc/development')
| -rw-r--r-- | doc/development/writing_documentation.md | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/development/writing_documentation.md b/doc/development/writing_documentation.md index 0a2d6e5891f..3f658ed58b2 100644 --- a/doc/development/writing_documentation.md +++ b/doc/development/writing_documentation.md @@ -27,6 +27,14 @@ They live under `doc/topics/topic-name/`, and can be searched per topic, within - **Technical Overviews**: technical content describing features, solutions, and third-party integrations - **Tutorials**: technical content provided step-by-step on how to do things, or how to reach very specific objectives +#### Understanding Guides and Tutorials + +Suppose there's a process to go from point A to point B in 5 steps: (A) 1 > 2 > 3 > 4 > 5 (B). + +A **guide** can be understood as a description of certain processes to achieve a particular objective. A guide brings you from A to B describing the characteristics of that process, but not necessarily going over each step. It can mention, for example, the step 3, but, assumes that that step is known by the reader, or out of the scope of that article. + +A **tutorial** requires a clear **step-by-step** guidance to achieve a singular objective. It brings you from A to B, describing precisely all the necessary steps involved in that process, showing each of the 5 steps to go from A to B. It does not assume that you step 3: it shows you each of them. + #### Special Format Every **Technical Article** contains, in the very beginning, a blockquote with the following information: |