# User Manual: [Product name] [version]

> Complete user manual for a software product or service. The structure
> follows the information-for-users content described in ISO/IEC/IEEE
> 26514:2022: identification, conventions, safety notices, concepts,
> task-oriented procedures, reference, troubleshooting and navigation aids.
> Replace every `[bracketed]` value and every row marked *Example*.

<!--
Guidance: How to use this template
- Write for the user's task, not for the product's menu structure. Readers
  arrive with a goal ("export a report"), so procedures are the core of the manual.
- Keep the three kinds of content apart: concepts explain, procedures
  instruct, reference lists facts. Link between them instead of mixing.
- Every procedure has a goal, prerequisites, numbered steps with one action
  each, and the result the user should see.
- Delete sections that do not apply (for example safety notices for a pure
  web app) but keep the numbering stable and say why in 1.4.
- Hidden notes like this one do not appear in the preview or in exports.
-->

## Document control

<!-- Guidance: Identify the manual so a user or support agent can tell exactly which product version it describes. Status moves Draft -> In review -> Approved -> Superseded. -->

| Field | Value |
|---|---|
| Document ID | [UM-PRODUCT-001] |
| Product and version | [Product name] [2.4] |
| Manual version | [0.1] |
| Status | [Draft / In review / Approved / Superseded] |
| Owner | [@docs-owner] |
| Approvers | [@product-owner], [@support-lead] |
| Classification | [Public / Customer confidential / Internal] |
| Last updated | YYYY-MM-DD |
| Delivery formats | [Web help / PDF / In-app help / Printed] |

### Approvals

| Role | Name | Decision | Date |
|---|---|---|---|
| Product owner | [@name] | [Approved / Rejected / Approved with comments] | YYYY-MM-DD |
| Technical reviewer | [@name] | [Decision] | YYYY-MM-DD |
| Support lead | [@name] | [Decision] | YYYY-MM-DD |
| Accessibility reviewer | [@name] | [Decision] | YYYY-MM-DD |

## Revision history

<!-- Guidance: One row per published version of the manual. Tie each change to the product release that caused it so users can match manual and software. -->

| Version | Date | Author | Product version | Change summary |
|---|---|---|---|---|
| 0.1 | YYYY-MM-DD | [@name] | [2.4] | Initial draft for review |
| 1.0 | YYYY-MM-DD | [@name] | [2.4] | *Example:* Approved for release; added 5.6 bulk export |
| 1.1 | YYYY-MM-DD | [@name] | [2.5] | *Example:* Updated 6.3 shortcuts; new error E-4012 in 8 |

## Contents

<!-- Guidance: Keep this list in sync with the headings. Long manuals also benefit from a task index in section 11. -->

1. [About this manual](#1-about-this-manual)
2. [Safety and important notices](#2-safety-and-important-notices)
3. [Product overview](#3-product-overview)
4. [Concepts](#4-concepts)
5. [Getting started](#5-getting-started)
6. [Tasks](#6-tasks)
7. [Reference](#7-reference)
8. [Troubleshooting](#8-troubleshooting)
9. [Error messages](#9-error-messages)
10. [Accessibility](#10-accessibility)
11. [Glossary and index](#11-glossary-and-index)
12. [Getting help](#12-getting-help)

## 1. About this manual

<!-- Guidance: Tell readers in a few lines whether this is the right document for them, what it assumes, and how to read it. Users skip long introductions, so keep it short. -->

### 1.1 Identification

This manual describes [Product name] version [2.4], released YYYY-MM-DD,
for [web browsers / Windows / macOS / Android / iOS]. It applies to the
[Standard / Professional / Enterprise] edition. Features available only
in some editions are marked with the edition name in the heading.

### 1.2 Intended audience

<!-- Guidance: Name the user roles and the knowledge you assume. If administrators have a separate guide, point to it here so they stop reading. -->

This manual is for [end users such as account managers and analysts]
who use [Product name] to [main goal, for example "prepare and share
monthly sales reports"]. It assumes you can use a web browser and know
[domain knowledge, for example "basic spreadsheet terms"]. Installation is
covered in the [Installation Guide] and administration in the
[Administrator Guide].

### 1.3 How this manual is organised

| If you want to | Read |
|---|---|
| Understand what the product does | 3 Product overview, 4 Concepts |
| Use the product for the first time | 5 Getting started |
| Complete a specific job | 6 Tasks |
| Look up a setting, field or shortcut | 7 Reference |
| Fix a problem or understand an error | 8 Troubleshooting, 9 Error messages |

### 1.4 Conventions

<!-- Guidance: Define every typographic and wording convention once, then apply it consistently. Inconsistent conventions are the most common review finding in manuals. -->

| Convention | Meaning | Example |
|---|---|---|
| **Bold** | Names of UI elements you click or select | Select **Save** |
| `Monospace` | Text you type, file names, code | Type `Q3-report` |
| *Italic* | New term defined in the glossary | A *workspace* holds projects |
| > Menu path | Sequence of menu selections | **File > Export > PDF** |
| [Edition] tag | Feature limited to an edition | [Enterprise] |
| Note | Helpful information that is easy to miss | Note: Drafts are kept 30 days. |
| Caution | Risk of losing data or work | Caution: Deleting a workspace cannot be undone. |
| Warning | Risk of harm to people or of a security breach | Warning: Do not share your recovery key. |

Sections omitted from this edition of the manual and the reason:
[none / "2.2 Physical safety omitted: software-only product"].

## 2. Safety and important notices

<!-- Guidance: Collect notices that apply across the whole product here and repeat each one at the step where the hazard occurs. Use the same signal words as 1.4. Keep notices short: hazard, consequence, how to avoid it. -->

### 2.1 Data and security notices

| Signal word | Hazard | Consequence | How to avoid it |
|---|---|---|---|
| Caution | *Example:* Permanent deletion of a workspace | All projects and files in it are lost | Export the workspace before deleting it (6.5) |
| Warning | *Example:* Sharing a public link | Anyone with the link can view the document | Use **Restricted** sharing for confidential content |
| Warning | [Hazard] | [Consequence] | [Avoidance action] |

### 2.2 Physical and health notices

[If the product has hardware, describe electrical, thermal or ergonomic
hazards here. For software products, describe relevant health notices
such as photosensitive content warnings, or state "Not applicable".]

### 2.3 Legal notices

[Trademark statements, licence summary and a pointer to the full
licence terms. This section records the notices; it is a format, not
legal advice.]

## 3. Product overview

<!-- Guidance: Describe what the product is for and its main parts in user terms. One overview diagram helps users build a mental model before they act. -->

### 3.1 Purpose

[Product name] helps [audience] to [primary job] by [key mechanism].
Typical uses are [use 1], [use 2] and [use 3]. It is not intended for
[out-of-scope use, for example "storing payment card data"].

### 3.2 Main components

The diagram below shows how the main parts relate.

```mermaid
flowchart LR
    U["User"] --> W["Workspace"]
    W --> P["Projects"]
    P --> D["Documents"]
    D --> E["Exports (PDF, CSV)"]
    W --> S["Sharing and permissions"]
```

| Component | What it does for you |
|---|---|
| *Example:* Workspace | Groups the projects of one team and controls who can see them |
| *Example:* Dashboard | Shows recent documents and tasks assigned to you |
| [Component] | [User-facing purpose] |

### 3.3 What is new in this version

- [New capability, with a link to the task that uses it]
- [Changed behaviour users will notice]
- [Removed feature and its replacement]

## 4. Concepts

<!-- Guidance: Explain the ideas a user needs before the procedures make sense: objects, states, rules. No steps here. Link each concept to the tasks that use it. -->

### 4.1 Key objects

| Concept | Explanation | Related tasks |
|---|---|---|
| *Example:* Draft | A document only you can see until you publish it | 6.2 |
| *Example:* Version | A saved snapshot you can compare with or restore | 6.4 |
| [Concept] | [Plain-language explanation] | [Task numbers] |

### 4.2 Document life cycle

A document moves through the states below. Only owners and editors can
change the state.

```mermaid
stateDiagram-v2
    [*] --> Draft
    Draft --> InReview: Submit
    InReview --> Draft: Request changes
    InReview --> Published: Approve
    Published --> Archived: Archive
    Archived --> [*]
```

### 4.3 Roles and what they can do

| Action | Viewer | Editor | Owner |
|---|---|---|---|
| View documents | Yes | Yes | Yes |
| Edit and comment | No | Yes | Yes |
| Share and change permissions | No | No | Yes |
| Delete | No | No | Yes |

## 5. Getting started

<!-- Guidance: Take a new user from nothing to a first success in under 15 minutes. Prefer one realistic path over every option. -->

### 5.1 Before you begin

You need:

- [An account created by your administrator, or self sign-up at the URL]
- [A supported browser or device; see 7.4]
- [Any data or files you want to import]

### 5.2 Sign in for the first time

1. Open `[https://app.example.com]` in a supported browser.
   The sign-in page appears.
2. Enter your work email address and select **Continue**.
   A verification code is sent to your email.
3. Enter the six-digit code and select **Verify**.
   The **Welcome** screen opens.
4. Choose your language and time zone, then select **Finish**.
   **Result:** Your dashboard opens and shows the sample project.

### 5.3 Tour of the main screen

| Area | Location | Use it to |
|---|---|---|
| *Example:* Navigation bar | Left edge | Move between Dashboard, Projects and Settings |
| *Example:* Toolbar | Top of the editor | Format text, insert tables, share |
| [Area] | [Location] | [Purpose] |

## 6. Tasks

<!-- Guidance: One subsection per user goal, titled with a verb ("Create a project"). Each has purpose, prerequisites, numbered steps (one action each), the expected result after key steps, and related tasks. Order tasks by frequency of use or by workflow. -->

### 6.1 Create a project

Create a project to group the documents for one piece of work.

**Before you start:** You need the Editor or Owner role in the workspace.

1. In the navigation bar, select **Projects**.
2. Select **New project**.
   The **New project** dialog opens.
3. In **Name**, type a name of up to 80 characters, for example `Q3 sales review`.
4. Optional: in **Template**, choose a starting template.
5. Select **Create**.
   **Result:** The project opens and appears in the **Projects** list.

**Related:** 6.2 Add a document, 4.3 Roles.

### 6.2 Add a document

1. Open the project.
2. Select **New document** and choose **Blank** or **Import file**.
3. If you import, select a `.docx`, `.md` or `.csv` file of up to 25 MB.
   A progress bar shows the import; large files take up to a minute.
4. Edit the title at the top of the page.
   **Result:** The document is saved automatically every few seconds.
   The status line shows **Saved**.

### 6.3 Share a document

> Warning: A public link gives access to anyone who has it. Use
> **Restricted** for confidential content.

1. Open the document and select **Share**.
2. Enter the email addresses of the people to invite.
3. Choose a role: **Viewer** or **Editor**.
4. Select **Send invitation**.
   **Result:** Invited people receive an email and the document shows
   their initials in the **Share** panel.

### 6.4 Restore an earlier version

1. Open the document and select **More > Version history**.
2. Select a version from the list to preview it.
3. Select **Restore this version**, then confirm.
   **Result:** The restored content becomes the current version. The
   version you replaced stays in the history.

### 6.5 [Task title starting with a verb]

[One sentence on why a user does this task.]

1. [Action]
2. [Action]
   **Result:** [What the user sees.]

## 7. Reference

<!-- Guidance: Facts users look up: every screen, field, setting, shortcut and limit. Use tables with consistent columns. No procedures here; link to section 6 instead. -->

### 7.1 Screens and UI elements

| Screen | Element | Type | Description |
|---|---|---|---|
| *Example:* Editor | **Share** | Button | Opens the Share panel (6.3) |
| *Example:* Editor | Status line | Text | Shows Saved, Saving or Offline |
| [Screen] | [Element] | [Button / Field / Menu] | [What it does] |

### 7.2 Settings

| Setting | Location | Values | Default | Effect |
|---|---|---|---|---|
| *Example:* Theme | Settings > Appearance | Light, Dark, System | System | Colour scheme of the interface |
| *Example:* Autosave interval | Settings > Editor | 2 to 60 seconds | 5 seconds | How often changes are saved |
| [Setting] | [Path] | [Allowed values] | [Default] | [Effect] |

### 7.3 Keyboard shortcuts

| Action | Windows / Linux | macOS |
|---|---|---|
| Save now | `Ctrl+S` | `Cmd+S` |
| Bold | `Ctrl+B` | `Cmd+B` |
| Find | `Ctrl+F` | `Cmd+F` |
| Open command palette | `Ctrl+Shift+P` | `Cmd+Shift+P` |
| [Action] | [Keys] | [Keys] |

### 7.4 System requirements and limits

| Item | Requirement or limit |
|---|---|
| Browsers | [Current and previous major version of Chrome, Edge, Firefox, Safari] |
| Maximum file size for import | [25 MB] |
| Maximum documents per project | [5,000] |
| [Item] | [Value] |

## 8. Troubleshooting

<!-- Guidance: Organise by symptom, in the user's words, not by internal cause. Give the quickest check first. End with how to contact support and what to include. -->

| Symptom | Likely cause | What to do |
|---|---|---|
| *Example:* Status line shows **Offline** | Network connection lost | Check your connection; changes are kept locally and sync when you reconnect |
| *Example:* Import stops at 99% | File exceeds 25 MB or uses an unsupported format | Split the file or save it as `.docx` and try again |
| *Example:* Invited user did not receive email | Message filtered as spam | Ask them to check spam, or copy the link from **Share > Copy link** |
| [Symptom] | [Cause] | [Action] |

## 9. Error messages

<!-- Guidance: List every message a user can see, exactly as displayed, with its meaning and the action to take. Support agents rely on this table. -->

| Code | Message as displayed | Meaning | What to do |
|---|---|---|---|
| E-1001 | *Example:* "Session expired. Sign in again." | You were inactive for more than 12 hours | Sign in again; unsaved changes are restored |
| E-2004 | *Example:* "You do not have permission to edit this document." | Your role is Viewer | Ask the owner for the Editor role |
| E-4012 | *Example:* "File type not supported." | Import accepts .docx, .md, .csv only | Convert the file and import again |
| [E-nnnn] | [Exact text] | [Meaning] | [Action] |

## 10. Accessibility

<!-- Guidance: Describe the accessibility features, how to turn them on, known limitations, and how to request an alternative format. Do not claim conformance you have not tested. -->

[Product name] is designed to meet [WCAG 2.2 level AA]. Conformance was
last evaluated on YYYY-MM-DD; see the [accessibility statement link].

| Feature | How to use it |
|---|---|
| Keyboard navigation | Every function is reachable with `Tab`, `Shift+Tab`, `Enter` and arrow keys |
| Screen reader support | Tested with [NVDA 2024.x on Windows, VoiceOver on macOS] |
| Text resizing | Zoom to 200% without loss of content |
| Reduced motion | Follows the operating system setting |
| High contrast | Settings > Appearance > High contrast |

Known limitations: [for example "charts in the analytics view have no
text alternative yet; use **Export > CSV** for the data"]. To request
this manual in another format, contact [accessibility@example.com].

## 11. Glossary and index

<!-- Guidance: Define product terms in plain language and keep the definitions consistent with the UI. For long manuals, generate an index of tasks and terms from headings rather than maintaining it by hand. -->

### 11.1 Glossary

| Term | Definition |
|---|---|
| *Example:* Workspace | The top-level container for a team's projects and members |
| *Example:* Owner | The role that can share, change permissions and delete |
| [Term] | [Definition] |

### 11.2 Index guidance

Build the index from task headings (verbs) and glossary terms (nouns).
Include the words users actually search for, such as synonyms from
support tickets ("delete" and "remove"), and point each entry to one
section number. For web help, the search box replaces the printed index
but still needs the synonym list.

| Index entry | See section |
|---|---|
| *Example:* Export, PDF | 6.5 |
| *Example:* Permissions, see Roles | 4.3 |
| [Entry] | [Section] |

## 12. Getting help

<!-- Guidance: Say where to go when the manual does not answer the question and what information support will ask for. -->

| Channel | Use it for | Response time |
|---|---|---|
| In-app help (**?** icon) | Searching this manual | Immediate |
| [support@example.com] | Problems not solved by section 8 | [1 business day] |
| [Community forum URL] | Questions and tips from other users | [Community] |

When you contact support, include your product version (**Help >
About**), the error code, the time it happened and the steps that led to it.

## Standard and licence note

Structure aligned with ISO/IEC/IEEE 26514:2022, *Systems and software
engineering: Design and development of information for users*, for the
content and organisation of user documentation (identification,
conventions, notices, concepts, procedures, reference, troubleshooting
and navigation aids). This template is original text written for this
collection and reproduces no text from the standard; obtain the standard
from ISO, IEC or IEEE for its normative requirements. Template licence: MIT.