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

Documentation review #272

Closed
5 of 8 tasks
FKlopfer opened this issue Dec 19, 2024 · 1 comment · Fixed by #304
Closed
5 of 8 tasks

Documentation review #272

FKlopfer opened this issue Dec 19, 2024 · 1 comment · Fixed by #304
Assignees
Labels
isType:Editorial An issue that contains general structural and editorial changes
Milestone

Comments

@FKlopfer
Copy link
Collaborator

FKlopfer commented Dec 19, 2024

The following list contains all tasks related to the review of the documentation by parson. Not included are tasks that are discussed in separate issues. "ASM" refer to rules in the ASAM Editorial Guide.

  • Check for occurrence of common Terms (e.g. ASAM Open Simulation Interface, other ASAM standards, 3D File Formats etc.) and write them in italics (see ASM-71)
  • Check the document for abbreviations and their consistency and add them to "3. Abbreviations"
  • Check the document for not allowed abbreviations according to ASM-65
  • Check the document for Terms and Definitions and their consistency, add them to "5. Terms and Definitions"
  • Check the use of slashes for conjunctions (see ASM-122)
  • Check typos
  • Check paragraphs uniquely identifiable, i.e 7.4 File Format, I´m not sure if we should have here separated subsections (see ASM-132)
  • Add missing anchors to figures and tables so they show up in the LoF/LoT
@FKlopfer FKlopfer added the isType:Editorial An issue that contains general structural and editorial changes label Dec 19, 2024
@FKlopfer FKlopfer added this to the v1.0.0 milestone Dec 19, 2024
@AsamDiegoSanchez
Copy link
Member

AsamDiegoSanchez commented Jan 7, 2025

Other remarks:

  • Check the use of trademark symbol (see ASM-137) in title and deliverable's name (We should add the registered trademark, at least one time in the tittle (see OpenDRIVE, OpenSCENARIO)
  • File names of deliverables (ASM-41): replace dots in version numbers by hyphens

@FKlopfer FKlopfer linked a pull request Jan 21, 2025 that will close this issue
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
isType:Editorial An issue that contains general structural and editorial changes
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants