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

functionalSpecification.md review #11

Open
14 of 22 tasks
MaximeTAlgosup opened this issue Jan 20, 2025 · 0 comments
Open
14 of 22 tasks

functionalSpecification.md review #11

MaximeTAlgosup opened this issue Jan 20, 2025 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation functional Functional specifications related medium Medium priority level

Comments

@MaximeTAlgosup
Copy link
Collaborator

MaximeTAlgosup commented Jan 20, 2025

Background Information

Errors and Improvements would be displayed this way:

Line number: error spotted -> potential solution

convention:

  • what is already written
  • what's wrong
  • potential solution

Improvement(s)

Naming convention

  • L.1: Functional specifications -> Functional specifications Specifications

Spelling errors

  • No spelling errors

links misbehavior

  • All links are working

tables malfunction

  • You should put capital letters at every part of roles + write the entire names

Coherency issues

  • Keep your titles constant, either put them in bold or not (I guess you don't have to)

Other Suggestion(s)

  • Put the Glossary at the end

  • There's no use of bolding titles in tables, it is done automatically.

  • Remove all the the numbers, it's not numbered list

  • Complete the glossary with actual terms

  • Add a table of content

  • Redo all the personas:

    • Add names to persona as titles.
    • Change the color
    • Make better definitions of the text as in Jaime's course
    • Do a better task definition
    • Enlarge the picture size
    • Reduce persona's picture
    • bigger the texts
  • Could create a design part for the menu if you want

  • Add stakeholders

  • Add non-functional requirements

  • Insert your pictures via GitHub

@MaximeTAlgosup MaximeTAlgosup added documentation Improvements or additions to documentation functional Functional specifications related medium Medium priority level labels Jan 20, 2025
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 functional Functional specifications related medium Medium priority level
Projects
None yet
Development

No branches or pull requests

3 participants