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.

Document control

Approvals

Revision history

Contents

1. About this manual
2. Safety and important notices
3. Product overview
4. Concepts
5. Getting started
6. Tasks
7. Reference
8. Troubleshooting
9. Error messages
10. Accessibility
11. Glossary and index
12. Getting help

1. About this manual

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

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

1.4 Conventions

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

2.1 Data and security notices

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

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.

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

4.1 Key objects

4.2 Document life cycle

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

4.3 Roles and what they can do

5. Getting started

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

6. Tasks

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

7.1 Screens and UI elements

7.2 Settings

7.3 Keyboard shortcuts

7.4 System requirements and limits

8. Troubleshooting

9. Error messages

10. Accessibility

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

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 [[email protected]].

11. Glossary and index

11.1 Glossary

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.

12. Getting help

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.