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: [Technical specification] #10

Closed
Clementine951 opened this issue May 29, 2024 · 2 comments
Closed

Document report: [Technical specification] #10

Clementine951 opened this issue May 29, 2024 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation question Further information is requested

Comments

@Clementine951
Copy link
Collaborator

Clementine951 commented May 29, 2024

Description

  1. Table of content
    1. Too low
    2. Twice a "5 in the Part III
      1. Pages and Authentication
    3. Authentication has only a subtitle
      1. A but no B
  2. Start of the document
    1. Document versions and information part are "useless"
    2. GitHub is already here for the control versioning
  3. Glossary
    1. Empty glossary
    2. To add
      1. API
      2. SDK
      3. ...
  4. Document purpose
    1. Repetitions and missing clarity (from my point of view, maybe not the case for others)
    2. The role of the technical is to decide how the functional will be implemented
    3. The scope and the objectives should be defined on the functional not the technical
    4. In the case these elements are not in the functional, it's a good thing
  5. Project definition
    1. You previously recommend to read the functional which is a good thing
    2. So, don't put functional parts on your technical
  6. Working environment
    1. The version of the SDK should be added
    2. Latest isn't specific enough if the document is read after a new release
  7. Minimum required version
    1. Good point for the minimum version
  8. III - 2 Database
  9. why is nothing on the lower part of the boxes?
  10. Table details and usage
  11. What is the difference between id and userId?
  12. C
    1. Are the matches going to be saved?
  13. Todo
    1. Data structurations
    2. Ways to interact
  14. 3 A Colors
    1. Should be on the functional (OK if it's not in it)
    2. Links to the graphic charter are not working (x2)
    3. In the sentence "good usage of_ " is the "_" normal?
  15. 3 B Typo
    1. Same as the colours, should be in the functional with the design choices
    2. But again ok if not on the functional
  16. 4 widgets
    1. Which is the best option to implement them, if multiple possibilities
    2. In Text field: What is the maximum length and why?
    3. Why no minimum length?
    4. Maximum and minimum length for password also?
    5. In Tag Field: why" _" in Tag _Field?
  17. 4 B Icon button
    1. Backslash "" at the end of the description
    2. Navbar is the generic word, think about using footer instead to avoid confusion with header
  18. 5
    1. A lot of things should be in the functional but as always, if not in the functional seems ok
    2. But pretty clear, know which type of element it is
    3. The footer is only visible on a few pages, is it normal or a thing you forgot?
  19. 5 subscription
    1. Miss the check for the data privacy, etc.
  20. 5 Settings
    1. According to the GDPR
      1. Get the data the app has about you
      2. Delete these data
    2. From where can you access the settings? (Only the swiping page?)
  21. 5 Job seeker profile
    1. The first time the footer is visible on the capabilities
  22. 5 authentication
    1. Only A and no B
  23. Part 6
    1. B to do
  24. Part 7
    1. Pretty clear maybe more information?
  25. Part 8 to do

Severity

  1. Medium (Should be fixed soon)

Version

version 0.02

Expected Correction

This review has been done knowing that the document isn't finished yet

Other Details

No response

@Clementine951 Clementine951 added documentation Improvements or additions to documentation question Further information is requested labels May 29, 2024
@Clementine951
Copy link
Collaborator Author

Clementine951 commented Jun 3, 2024

With the commit : f7c0be1

  • Still have the 'Document Information' and 'Document Versions'
  • Still things that should be on the functional
    • This won't be put upfront any more.
  • Still missing close up on the data privacy
    • This is a legal constraints
  • Still didn't precise if the navbar is a header or a footer

@Clementine951
Copy link
Collaborator Author

This issue has been closed because the remaining issues have been moved in the issues #15 and #16.
This has been done for more clarity for the assignees.

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 question Further information is requested
Projects
None yet
Development

No branches or pull requests

2 participants