You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Adds information specific to the GitHub tooling, such as linking and where to place image files. Also corrects some formatting. Also introduces the `00Incoming` folder for guides without a known place in the structure.
If you're writing a step-by-step guide and don't yet know where to place it in the structure, feel free to put the file here, within the `00Incoming` folder. Reviewers will look at your guide and find a place for it before it is merged into the guides.
Copy file name to clipboardExpand all lines: Documentation/90Contribute/10Template/Index.md
+30-27Lines changed: 30 additions & 27 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,67 +2,70 @@
2
2
3
3
*This template includes writing instructions {in curly brackets} and boilerplate text that you can customize with your own text. The [step-by-step Contributor Guide](../20ContributorGuide/Index.md) explains each section in detail, and includes example text for each section. Search the [Guide Registry](../../80GuidesRegistry/Index.md) before you start - your guide might already exist!*
4
4
5
+
{The template includes an HTML comment with different tags for categorization (look in the source code). Include the ones you think fits and feel free to add new ones. A tag like #TYPO3v13 indicates that the step-by-step guide has been tested in TYPO3 v13. To credit yourself as author, use "@" followed by your my.typo3.org username (e.g. "@username").}
{Feature} enables you to {address pain point}. {Task you are going to learn} helps you {achieve goal}.
10
+
{Provide a conceptual overview.}
11
+
12
+
{Feature} enables you to {address pain point}. {Task you are going to learn} helps you {achieve goal}.
10
13
11
14
## Learning objective
12
15
13
-
In this step-by-step guide you will {describe what the learner will accomplish}.
16
+
In this step-by-step guide you will {describe what the learner will accomplish}.
14
17
15
18
## Prerequisites
16
19
17
20
### Tools and technology
18
21
19
-
* {Hardware specifications}
20
-
* {Software installed}
21
-
* {Environments}
22
+
* {Hardware specifications}
23
+
* {Software installed}
24
+
* {Environments}
22
25
23
26
### Knowledge and skills
24
27
25
-
* {Conceptual knowledge}
28
+
* {Conceptual knowledge}
26
29
* {Prior learning}
27
30
28
31
## Watch the video
29
32
30
-
{**Optional**. If available, embed the YouTube video version of this tutorial from the TYPO3 official channel.}
31
-
33
+
{**Optional**. If available, embed the YouTube video version of this tutorial from the TYPO3 official channel.}
34
+
32
35
Watch this video to follow along with the steps below.
33
36
34
37
## {Task name}
35
38
36
39
> **Scope check time**
37
40
>
38
41
> Don't start writing until you have a clear scope.
39
-
>
40
-
> If you're unsure about the goal, the audience, or the prerequisites — go back and fix it now. Writing the task section without a solid scope will lead to frustration when you’re deep
42
+
>
43
+
> If you're unsure about the goal, the audience, or the prerequisites — go back and fix it now. Writing the task section without a solid scope will lead to frustration when you’re deep
41
44
> in the details.
42
45
43
46
{Optional explanatory text}
44
47
45
-
1. {Write the first step. Start with a verb.}
46
-
{Optional: Code sample or screenshot that helps the learner complete this step.}
47
-
{Optional: Expected outcome.}
48
+
1. {Write the first step. Start with a verb.}
49
+
{Optional: Code sample or screenshot that helps the learner complete this step.}
50
+
{Optional: Expected outcome.}
48
51
2. {Write the next step. Start with a verb.}
49
52
50
53
## {Task name}
51
54
52
55
{Optional explanatory text}
53
56
54
-
1. {Write the first step. Start with a verb.}
55
-
{Optional: Code sample or screenshot that helps the learner complete this step.}
56
-
{Optional: Expected outcome.}
57
+
1. {Write the first step. Start with a verb.}
58
+
{Optional: Code sample or screenshot that helps the learner complete this step.}
59
+
{Optional: Expected outcome.}
57
60
2. {Write the next step. Start with a verb.}
58
61
59
62
## {Task name}
60
63
61
64
{Optional explanatory text}
62
65
63
-
1. {Write the first step. Start with a verb.}
64
-
{Optional: Code sample or screenshot that helps the learner complete this step.}
65
-
{Optional: Expected outcome.}
66
+
1. {Write the first step. Start with a verb.}
67
+
{Optional: Code sample or screenshot that helps the learner complete this step.}
68
+
{Optional: Expected outcome.}
66
69
2. {Write the next step. Start with a verb.}
67
70
68
71
{For Project guides, use this section to link to existing step-by-step guides}
@@ -71,22 +74,22 @@ Watch this video to follow along with the steps below.
71
74
72
75
{State the outcome of the step-by-step guide to recap what the learner has achieved.}
73
76
74
-
Congratulations! You now have {outcome}.
77
+
Congratulations! You now have {outcome}.
75
78
76
79
## Next steps
77
80
78
81
{List links to tasks that the learner could do next.}:
79
82
80
83
Now that you have {achieved goal}, you might like to:
TYPO3 step-by-step guides are hands-on tutorials designed to help newcomers **accomplish one practical task**.
4
+
5
+
Inspired by the [Diátaxis framework](https://diataxis.fr/map/#expectations-and-guidance), which emphasizes distinct content types in technical documentation, step-by-step guides map to the *tutorials* category.
6
+
7
+
TYPO3 step-by-step guides follow a few key principles:
8
+
9
+
***Hands-on learning**: The fastest way to learn is by doing.
10
+
***One clear path**: No branches — just one method that works, from start to finish.
11
+
***Minimal explanation**: Explain only what’s necessary to keep someone moving. Link out for deeper context.
12
+
***A successful finish**: Every step produces visible progress, and the outcome is reliable and repeatable.
13
+
***Aligned with TYPO3’s official documentation**: Linking out to deeper material as needed.
14
+
* Takes **less than 30 minutes** to complete
15
+
16
+
> [!TIP]
17
+
> A good step-by-step guide follows the [single-responsibility principle (SRP)](https://en.wikipedia.org/wiki/Single-responsibility_principle): **it should do one thing, and do it well.** > Every step contributes directly to a single learning objective, and nothing more.
18
+
>
19
+
> If you find yourself adding “If…” or “Alternatively…”, your guide may violate the single-responsibility principle.
20
+
21
+
## What are they not?
22
+
23
+
Step-by-step guides aren’t examples. Examples are usually found in the documentation, and help to illustrate concepts — they are meant to be studied and understood. Step-by-step guides, in contrast, take the reader through a path of sequential steps, and are designed to be actively followed to learn a new concept.
24
+
25
+
## Modular by design
26
+
27
+
Step-by-step guides are modular. Each guide is an atomic unit of action — small, focused, and self-contained, with one learning objective and one clear outcome. Guides can be combined to form larger tutorials or workshops, or used independently for self-led learning.
28
+
29
+
## How do step-by-step guides fit in the existing TYPO3 documentation ecosystem?
|**Information oriented** Supports exploration and problem-solving for people seeking answers or understanding. |**Learning oriented** Helps people learn through hands-on experience. |
34
+
|**Comprehensive** Presents various approaches, configurations, and possibilities. Also covers edge cases. |**Single clear path** Follows a carefully managed path from start to finish with guaranteed success. |
35
+
|**Blends doing and explaining** Combines how-to instructions, explanations, and reference information. |**Focused on doing** Prioritizes action with minimal explanation. Links out to deeper material in the documentation. |
Copy file name to clipboardExpand all lines: Documentation/90Contribute/20ContributorGuide/20WhatAreProjectGuides.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,29 +1,29 @@
1
1
# What are project guides?
2
2
3
-
A project guide is made up of multiple step-by-step guides.
3
+
A project guide is made up of multiple step-by-step guides.
4
4
5
5
Project guides help learners complete multi-part processes by combining individual tasks into a coherent whole. They provide a clear learning sequence and maintain a narrative that shows how the parts fit together.
6
6
7
7
## How project guides extend step-by-step guides
8
8
9
-
Project guides compose several atomic step-by-step guides into a larger or more advanced outcome.
9
+
Project guides compose several atomic step-by-step guides into a larger or more advanced outcome.
10
10
11
-
Use a project guide when:
11
+
Use a project guide when:
12
12
13
-
* Multiple distinct tasks are required
14
-
* Some tasks are already covered in other guides
13
+
* Multiple distinct tasks are required
14
+
* Some tasks are already covered in other guides
15
15
* It would take more than 30 minutes or feel overwhelming as one block
16
16
17
17
**Examples**
18
18
19
-
* Build a multilingual site
19
+
* Build a multilingual site
20
20
* Develop a custom frontend plugin with user authentication
21
21
22
22
## Project guides are modular
23
23
24
24
Project guides follow the same template as regular step-by-step guides, the only difference is that the Task section looks a bit different.
25
25
26
-
Project guides are **fully modular**. They are made entirely by linking out to existing step-by-step guides, like ingredients in a recipe.
26
+
Project guides are *fully modular*. They are made entirely by linking out to existing step-by-step guides, like ingredients in a recipe.
27
27
28
28
You should only create a project guide once all the step-by-step guides it depends on have been created. This helps avoid incomplete or blocked project guides.
0 commit comments