Template:PT How-to article: Difference between revisions

This page exists on the shared resources wiki
Autogenerated
 
Autogenerated
 
Line 3: Line 3:
{|
{|
|-
|-
!Application:
!Topic / application:
|name of topic
|Which product, process or system does this article describe?
|-
!Target group:
|Who are these instructions written for?
|}
|}
</div>
</div>
Line 11: Line 14:
|-
|-
!Status:
!Status:
| '''draft''' / approved
| class="select" |'''draft''' / in review / approved
|-
!Last reviewed:
|mm/dd/yyyy
|}
|}
</div>
</div>
</div>
</div>
==Goal==
== 🎯 Goal ==
Brief overview — what is the goal of this instruction?
Describe in one or two sentences what readers are able to do after following this article.


==Prerequisites and preparations==
''Example: After completing these steps, you can export a wiki page as a PDF file and share it with your colleagues.''
What is required to complete the following steps or to achieve the goal?


==Procedure 1==
== 🧰 Prerequisites ==
Explain the outcome of this procedure. In  the table below, list each high-level step which will be documented in detail below the table.
List everything that is needed before the first step: permissions, tools, access data, materials or previous knowledge.
 
*Requirement 1 – ''e.g. edit rights in the affected namespace''
*Requirement 2 – ''e.g. software XY as of version 2.0''
 
{{Textbox|boxtype=note|header=Before you start|text=Note here what has to be checked, backed up or approved before the first step. Delete this box if you do not need it.|icon=yes}}
 
== 🛠️ Procedure 1 ==
Name the result of this procedure in one sentence. The table gives readers a quick overview, the detailed instructions follow below.
{| class="wikitable" style="width:100%;"
{| class="wikitable" style="width:100%;"
! style="vertical-align:middle;text-align:center;width:80px;" |Step
! style="vertical-align:middle;text-align:center;width:80px;" |Step
Line 29: Line 42:
|-
|-
| style="vertical-align:middle;text-align:center;width:80px;" |1
| style="vertical-align:middle;text-align:center;width:80px;" |1
|
|Short summary of the step
|
|Hint, link or exception
|-
|-
| style="vertical-align:middle;text-align:center;width:80px;" |2
| style="vertical-align:middle;text-align:center;width:80px;" |2
Line 43: Line 56:
=== Step-by-step instructions ===
=== Step-by-step instructions ===


# '''Do''' step 1
# '''Open''' the page or dialog where the task starts.
# '''Do''' step 2
# '''Select''' the required option.
## '''Do''' substep 2.1
## '''Confirm''' your entry.
# '''Do''' step 3
# '''Save''' your changes.
 
{{Textbox|boxtype=tip|header=Working with screenshots|text=To add an image below a step without interrupting the numbering, hold down the Shift key when you insert the line break.|icon=yes}}


==Procedure 2 ==
== 🛠️ Procedure 2 ==
Explain the outcome of this procedure. In  the table below, list each high-level step which will be documented in detail below the table.
Name the result of this procedure in one sentence. Copy this section as often as you need it – or delete it if one procedure is enough.
{| class="wikitable" style="width:100%;"
{| class="wikitable" style="width:100%;"
! style="vertical-align:middle;text-align:center;width:80px;" |Step
! style="vertical-align:middle;text-align:center;width:80px;" |Step
Line 56: Line 71:
|-
|-
| style="vertical-align:middle;text-align:center;width:80px;" |1
| style="vertical-align:middle;text-align:center;width:80px;" |1
|
|Short summary of the step
|
|Hint, link or exception
|-
|-
| style="vertical-align:middle;text-align:center;width:80px;" |2
| style="vertical-align:middle;text-align:center;width:80px;" |2
Line 70: Line 85:
=== Step-by-step instructions ===
=== Step-by-step instructions ===


# '''Do''' step 1
# '''Open''' the page or dialog where the task starts.
# '''Do''' step 2
# '''Select''' the required option.
## '''Do''' substep 2.1
## '''Confirm''' your entry.
# '''Do''' step 3
# '''Save''' your changes.
 
== ⚠️ Troubleshooting ==
Describe typical problems and how to solve them. Delete this section if it is not needed.
{| class="wikitable" style="width:100%;"
!Problem
!Possible cause
!Solution
|-
|Error message or unexpected behavior
|Why does this happen?
|What helps?
|-
|..
|
|
|}


==Related pages==
== 🔗 Related pages ==


*Link to related page 1
*Page title – ''what will readers find there?''
*Link to related page 2
*Page title – ''what will readers find there?''

Latest revision as of 04:57, 3 November 2026

Topic / application: Which product, process or system does this article describe?
Target group: Who are these instructions written for?
Status: draft / in review / approved
Last reviewed: mm/dd/yyyy

🎯 Goal

Describe in one or two sentences what readers are able to do after following this article.

Example: After completing these steps, you can export a wiki page as a PDF file and share it with your colleagues.

🧰 Prerequisites

List everything that is needed before the first step: permissions, tools, access data, materials or previous knowledge.

  • Requirement 1 – e.g. edit rights in the affected namespace
  • Requirement 2 – e.g. software XY as of version 2.0
Before you startNote here what has to be checked, backed up or approved before the first step. Delete this box if you do not need it.

🛠️ Procedure 1

Name the result of this procedure in one sentence. The table gives readers a quick overview, the detailed instructions follow below.

Step What to do Notes
1 Short summary of the step Hint, link or exception
2
3

Step-by-step instructions

  1. Open the page or dialog where the task starts.
  2. Select the required option.
    1. Confirm your entry.
  3. Save your changes.
Working with screenshotsTo add an image below a step without interrupting the numbering, hold down the Shift key when you insert the line break.

🛠️ Procedure 2

Name the result of this procedure in one sentence. Copy this section as often as you need it – or delete it if one procedure is enough.

Step What to do Notes
1 Short summary of the step Hint, link or exception
2
3

Step-by-step instructions

  1. Open the page or dialog where the task starts.
  2. Select the required option.
    1. Confirm your entry.
  3. Save your changes.

⚠️ Troubleshooting

Describe typical problems and how to solve them. Delete this section if it is not needed.

Problem Possible cause Solution
Error message or unexpected behavior Why does this happen? What helps?
..
  • Page title – what will readers find there?
  • Page title – what will readers find there?