Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document report: [User Manual | Understanding] #34

Open
Clementine951 opened this issue Jun 13, 2024 · 1 comment
Open

Document report: [User Manual | Understanding] #34

Clementine951 opened this issue Jun 13, 2024 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@Clementine951
Copy link
Collaborator

Description

  1. The part, “Where can I find…”, should be found like that is a user manual.
    The user manual target the users! The users won't go on GitHub to find it.
    When I asked where this manual will be found, it was more for the design and the formatting of the document rather than asking for a link.

  2. In context
    This part is missing space, you could have a line break before “Adopte1Candidat is a mobile" or "Thanks to our matching".

Also in this part, when you said "we offer you", I found it kind of weird.
Like do we really offer it?

  1. Installing the app
    The links are not working. I know it's because the app isn't on the downloading platform, but you should find a solution.

  2. Create your account
    At the end of this part, you wrote, "You are now logged into your account".
    Are you really directly logged after creating your account ?
    Or do you have to log in before?

Summary:
Your user manual is sometimes missing clarity. The user could be easily lost, depending on their understanding of the functioning of an app.

Severity

  1. High (Immediate attention needed)

Version

05a1390

Expected Correction

  1. If you want to keep this part, it would be preferable to put it at the end of the document.
  2. You could put a note "Not available yet"
  3. Be clear about the way to log in after the account creation with the development team.

Other Details

Don't forget that this document is for a user and not for a member of your teams or of the company.

This document should be clear and concise.

@AlexisLasselin
Copy link
Collaborator

AlexisLasselin commented Jun 13, 2024

  1. Can't really precise where it will be post at the end of the project, maybe Adopte1Candidat will create a website where you can see the guide.
  2. Done in the commit f89c5a1
  3. Same (offer replaced by suggest)
  4. Once the account created, you're directly inside the app.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants