タスクのトピックタイプ

タスクは手順を完了するための指示を与えます。

タスクはこの形式であるべきです：

# Title (starts with an active verb, like "Create a widget" or "Delete a widget")

Do this task when you want to...

Prerequisites (optional):

- Thing 1
- Thing 2
- Thing 3

To do this task:

1. Location then action. (Go to this menu, then select this item.)
1. Another step.
1. Another step.

Task result (optional). Next steps (optional).

以下はその例です。

# Create an issue

Create an issue when you want to track bugs or future work.

Prerequisites:

- You must have at least the Developer role for the project.

To create an issue:

1. On the left sidebar, select **Search or go to** and find your project.
1. Select **Plan > Issues**.
1. In the upper-right corner, select **New issue**.
1. Complete the fields. (If you have reference content that lists each field, link to it here.)
1. Select **Create issue**.

The issue is created. You can view it by going to **Plan > Issues**.

タスクのトピックタイトル

タイトルテキストには、active verb +nounという構造を使用します。たとえば、Create an issue。

ページ上の複数のタスクが前提条件を共有している場合は、Prerequisites というタイトルで別のトピックを作成できます。

タスクにステップが 1 つしかない場合

ステップが1つしかないタスクを書く必要がある場合、そのステップを順序なしのリストアイテムにします。このフォーマットはステップを目立たせ、リストのルールとの一貫性を保ちます。

使用例：

# Create a merge request

To create a merge request:

- In the upper-right corner, select **New merge request**.

あるタスクを実行するために複数の方法が存在する場合

UIでタスクを実行する複数の方法が存在する場合、主要な方法だけを文書化すべきです。

しかし、タスクを実行する複数の方法を文書化しなければならないこともあります。このような場合

  • 通常どおり、仕事を紹介します。次に、仕事を実行する方法ごとに、トピックのタイトルを追加します。
  • トピックのタイトルは、タスクのトピックのタイトルの 1 レベル下に入れ ます。
  • タスクを降順に並べます。
  • タスクのタイトルはできるだけ簡潔にしてください。可能であれば、infinitive +nounを使ってください。

以下はその例です。

# Change the default branch name

You can change the default branch name for the instance or group.
If the name is set for the instance, you can override it for a group.

## For the instance

Prerequisites:

- You must have at least the Maintainer role for the instance.

To change the default branch name for an instance:

1. Step.
1. Step.

## For the group

Prerequisites:

- You must have at least the Developer role for the group.

To change the default branch name for a group:

1. Step.
1. Step.

UIとAPIでタスクを実行するには

通常、UIで実行するのと同じタスクを実行するためのAPIが存在します。

このような状況が発生した場合

  • APIへの1文のリンクに別の見出しを使用しないでください。
  • API の例をUse GitLabdocumentation に含めないでください。API の例は API ドキュメントに属するものです。API ドキュメントはいつか移動するかもしれません。
  • API に言及する必要がなければ、言及しないでください。ユーザーはAPIドキュメントを検索できますし、余計なリンクは混乱を招きます。

  • もし誰かがAPIについて言及することを強く望むなら、UIタスクの最後にこの一文を追加してください：

    To create an issue, you can also [use the API](link).

タスクの紹介

タスクのトピックを始めるには、active verb +nounという構造を使い、アクションに関するコンテキストを提供します。例えば、Create an issue when you want to track bugs or future work。

タスクステップを開始するには、簡潔なアクションの後にコロンを使用します。例To create an issue:

タスクの前提条件

ベストプラクティスとして、タスクがユーザーにゲスト以外のロールを要求する場合、前提条件に最小ロールを記述します。各ロールのフレーズの書き方については、単語リストを参照してください。