How-to

This section provides how-tos for common tasks. Users get guidance on how to perform specific tasks for real-world scenarios.

What to write?
Intention

Intention of this section is to guides for users of the product on how to perform specific tasks. This should help improve the user experience and reduce the number of support requests. Be concise and clear in your instructions. You can assume some level of familiarity with the product, but don’t assume that the user is an expert. Add references to "reference" and "concepts" sections where appropriate. See How-to guides in diataxis for more information.

What to include

  • Set up the project

  • Typical use cases

    • Example: Backup

    • Example: Restore

    • Example: Upgrade

  • Configuration

  • User management

  • Troubleshooting

External resources
Example 1. Dependency maintenance routine guide

User management guide

This section provides guidance on how to manage users in the system. Adding, removing, and updating users is a common task for administrators. This guide provides step-by-step instructions.

  1. Open user management site

  2. Create user

    • Click the "Create User" button.

    • Fill in the user details.

    • Click "Save".

  3. Update user

    • Click the "Edit" button next to the user you want to update.

    • Update the user details.

    • Click "Save".

  4. Delete user

    • Click the "Delete" button next to the user you want to delete.

    • Confirm the deletion.