Context

Last Updated : Nov 09, 2022 |
Prolog information
Metadata
Keywords:
Include context (About this task) at the beginning of your task topic. This conceptual information explains the purpose of the procedure and provides information that the user needs to know. When writing context, do not repeat the name of the procedure. For example, if the title of the task topic is Making a call, do not write Use this procedure to make a call. Focus on information that is relevant to the user and avoid redundancy. The information that is relevant depends on the audience you are writing for. For example, in a Using document for end users, do not include detailed information about administration requirements.
When writing context, consider the following:
  • What, Why Explain the purpose of the procedure and why it is useful. This information is important to include in the context because it enables the reader to immediately decide whether the procedure is relevant to them.
  • Who Include this information if the procedure applies to a specific type of user. If the target audience for the document is end users and the procedure is intended for all end users, you do not need to include this information in the task topic. However, if the procedure only applies to a specific group of users, such as supervisors, specify this in the context.
  • When Indicate when to perform the procedure. For example, if the user performs the action during a meeting, state this in the context. If the procedure is time-sensitive or can result in a temporary service outage, you must inform the user so they can plan accordingly.
  • Where You must provide location or navigational information in the procedure. Depending on the complexity of the UI, consider providing some navigational information in the context.