Proposal - Outline for technical guides

[TuThoThai]

This is the proposal of the generic outline for any technical guides of NeTEx

1. Introduction & Scope (very short)
2. Scope
3. Definitions and abbreviations
4. Use cases and their modelling in NeTEx (including link to extract of XML files from the GitHub repo)
5. If relevant, additional annexes

Notes:

1. These guides should be published as part of the NeTEx GitHub repo, so extracts of XML files can be versioned and checked against a certain verison of the XSD.
2. These guides should not contain UML & XSD extracts, but should point to each relevant section in Transmodel / NeTEx documentation. Above all, they should point to resources on the NeTEx GitHub repository.

[TuThoThai]

Input from @einarbjorkevoll, @SaraGuerraOliveira, @hfjelstad, and @thbar:

• We could have "micro-UML" using light tool such as Mermaid
• In the part 4, make sure that choices (optional, mandatory, optionnaly mandatory) in the NeTEx XSD are made apparent and have a "human readable" description / explanation on how to fill the attribute
• For the part 3, find a way to move if further down or apart from the technical guides to be browsed elsewhere
• For the part 1 & 2, they should be kept very short, straightforward and what is required to understand that technical guide

As of 5 May 2026, agreement on the general content with the removal of part 3 + merge of part 1 and 2