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 1.01 | Start] #15

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

Document report: [Technical 1.01 | Start] #15

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

Comments

@Clementine951
Copy link
Collaborator

Description

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

Severity

  1. 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.

@Clementine951 Clementine951 added the documentation Improvements or additions to documentation label Jun 4, 2024
@MaximeAlgosup
Copy link
Collaborator

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

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