33=====
44Tasks
55=====
6+ .. default-domain:: mongodb
67
7- .. include:: /style-guide/includes/page-needs-update.rst
8-
8+ .. include:: /includes/styles/corrections.rst
99A *task* is an action that users perform to achieve a goal, such as
1010creating a server. A task topic, article, or section provides the
1111action steps and the necessary context and reference information that
@@ -29,12 +29,11 @@ makes more sense or is necessary for clarity.
2929
3030.. example::
3131
32- - Create users in SQL Server
33- - Configure SQL Server Management Studio to connect to SQL Server on
34- Windows
35- - Add new ServiceNet routes to a server
32+ - Restart a Running Deployment
33+ - Install Ops Manager from Archive on Linux
34+ - Add Existing MongoDB Processes to Ops Manager
3635
37- For guidelines about capitalizing titles, see
36+ To learn how to capitalize titles, see
3837:ref:`titles-and-headings`.
3938
4039Task Page Structure
@@ -58,10 +57,24 @@ especially if it will take a long time.
5857 informational topic or in a topic that introduces the task as part
5958 of a larger process or user goal.
6059
60+ Considerations
61+ ~~~~~~~~~~~~~~
62+
63+ If the task has items that the user should acknowledge or contemplate
64+ before taking action, describe them in a "Considerations" section that
65+ precedes any prerequisites or the procedure. You could include the
66+ following information:
67+
68+ - Descriptions of variations, options, or scopes
69+ - Hyperlinks to information that prepares the user for any choices they
70+ must make
71+ - Impacts on other areas of the product or later tasks they might want
72+ to complete
73+
6174Prerequisites
6275~~~~~~~~~~~~~
6376
64- If the task has requirements that the user *must* meet before taking
77+ If the task has requirements that the user *must* meet * before* taking
6578action, describe them in a "Prerequisites" section that precedes the
6679steps. You could include the following information:
6780
@@ -84,7 +97,7 @@ Procedures
8497A task contains one or more *procedures*, or set of sequential action
8598steps. Consider the following guidelines when creating a procedure:
8699
87- - If the procedure has more than one step, use a numbered list for the
100+ - If the procedure has more than one step, use a ``steps`` file for the
88101 steps. Don't use bullets, except to list choices within a step.
89102- If the procedure has only one step, show that step in a regular
90103 paragraph. That is, don't number it.
0 commit comments