Document report: [Technical 1.01 | Start]

algosup / 2023-2024-project-5-flutter-team-3

5th project of the year 2023-2024

MIT License

7 stars 0 forks source link

Document report: [Technical 1.01 | Start] #15

Open Clementine951 opened 4 weeks ago

Clementine951 commented 4 weeks ago

Description

As said in the issue #10, GitHub is a control versioning tool. So your first tables are useless.

Severity

Medium (Should be fixed soon)

Version

1.01

Expected Correction

Remove the 'Document Information' and the 'Document Version' tables from the top of the document. You can name your commit with the document version instead, and use the description to note what you've done.

Other Details

As a plus, your table of contents is a bit too low.

MaximeAlgosup commented 3 weeks ago

Document version part had been removed, I prefer to keep a document control with the following informations:

Document Owner
Creation Date
Last Update Date
Document Name
Current Version It will give to any lecturer essential information as well as keeping a version number is useful for the issues

Result in commit: aaab5017dc927cf1cc29ff97f54e1ab5245e0c45