# Document a Product Workflow

This page explains how to create and refine documentation for a product workflow in Atloria. Clear workflow documentation helps readers understand the order of actions, decisions, and expected outcomes in a product experience.

## Overview

Product workflow documentation describes how someone moves through a multi-step experience, such as reviewing information, creating a payment, or completing a maintenance request. Rather than listing isolated features, a workflow document connects the steps in the order a user performs them.

You can manage workflow documentation from **Documents**. Use **Search documents...** to find an existing document when you need to update, review, compare, or translate it. When you are starting a new workflow, create a new document and write the experience as a sequence of user actions.

As you prepare the document, focus on what the reader sees and does: screen names, visible buttons, menu items, field labels, and results. For example, a workflow can direct the reader to select **Create Payment**, review **1 Review Summary**, and use **Next Steps** to continue.

> 📷 _Screenshot pending: The Documents page showing the document list and the Search documents... field._

## Prerequisites

Before you begin, make sure you have:

- Access to the Atloria workspace where the product documentation is managed.
- A clear understanding of the product experience you want to document.
- The intended audience for the workflow, such as end users or internal reviewers.
- The names of the screens, buttons, menu items, and fields that users will encounter.
- Any screenshots or visual references needed to explain complex screens.
- An existing document selected if you are updating, comparing, translating, or reviewing documentation rather than creating it.

## Step-by-Step Instructions

1. Open **Documents** from the Atloria application navigation.

2. Select **Search documents...** if you want to locate an existing workflow document.

3. Enter a distinctive word from the workflow title in the **Search documents...** field.

4. Select the matching document from the search results if you are revising an existing workflow.

5. Start a new document if no existing document covers the product experience you need to explain.

6. Enter a descriptive title that identifies the user goal, such as “Create a Payment” or “Review a Product Summary.”

7. Write a one- or two-sentence introduction that tells readers what they will accomplish and why the workflow matters.

8. Add an **Overview** section that explains when users should use the workflow.

9. Add a **Prerequisites** section that lists what readers need before they start.

10. Add a **Step-by-Step Instructions** section for the main workflow.

11. Write one user action per numbered step.

12. Name the screen, menu item, button, or field exactly as the user sees it.

13. Direct the reader to select **Create Payment** when the workflow begins a payment process.

14. Direct the reader to review **1 Review Summary** when the workflow includes a summary or confirmation stage.

15. Direct the reader to select **Next Steps** when the reader needs to continue beyond the current stage.

16. Use **Back to Review** when your instructions need to explain how a user returns to the review experience.

17. Describe the visible result after each important action, such as a review summary appearing or the next stage becoming available.

18. Add a screenshot placeholder immediately after a step when a visual reference will help the reader recognize the screen.

19. Select **View Source** or **Source** only when you need to review the source-oriented view of the document content.

20. Compare the document with another version when you need to verify what changed before sharing the updated workflow.

21. Review the completed workflow from beginning to end as though you are the intended reader.

22. Save or finalize the document according to the options available in your workspace.

> 📷 _Screenshot pending: A workflow document section that instructs users to review 1 Review Summary and continue with Next Steps._

## Tips and Best Practices

- Use task-focused titles. A title such as “Create a Payment” is easier to find and understand than a broad title such as “Payments.”
- Keep each numbered instruction to a single action. If users must select **Create Payment** and then complete a field, make those separate steps.
- Use the exact visible label whenever possible. For example, write **Search documents...**, **Documents**, **Next Steps**, and **Back to Review** exactly as they appear.
- Explain what changes after an action. Readers need to know whether they should see a summary, return to a review screen, or move to the next stage.
- Add screenshots for screens with several choices, unfamiliar terminology, or review information that readers must verify.
- Use comparisons when updating a workflow. Reviewing differences helps you confirm that new instructions do not remove an important step or change the intended order.
- Use translation tools only after the workflow is complete in its original language. This reduces the chance of revising several language versions repeatedly.
- Keep source-oriented content separate from user instructions. **View Source** and **Source** can help with review, but end-user workflow steps should describe the visible product experience.

## Related Pages

- [Manage Documents](#)
- [Search for Documentation](#)
- [Compare Document Versions](#)
- [Translate a Document](#)
- [Review Product Documentation](#)
- [Create User Guides](#)

## Troubleshooting

### You cannot find the workflow document

Use **Search documents...** and search with a unique word from the title. If the document still does not appear, check whether the workflow was created under a different title or whether you need access to the relevant workspace.

### The instructions do not match the product screen

Revisit the product experience and confirm the exact labels shown to users. Update instructions to use visible text such as **Create Payment**, **1 Review Summary**, or **Next Steps**, rather than internal names or assumptions.

### You are unsure what changed in an updated workflow

Open the document comparison view and review the differences before publishing or sharing the revised content. Pay particular attention to changed step order, removed prerequisites, and screenshots that no longer match the current experience.