search

openETCS / toolchain

WP7: Top Level Project for the toolchain
26 stars 30 forks source link

Link between documentation and requirements #444

Closed cecilebraun closed 8 years ago

cecilebraun commented 10 years ago

@MarcBehrens wrote on openETCS/validation/issues/74:

Could you provide a type of link which can be inserted into a LaTeX document
 to open the specific requirement once selected inside the compiled LaTeX document.
cecilebraun commented 10 years ago

@janWelte Could you provide a more precise use case ?

janWelte commented 10 years ago

For verification (and traceability) we need to show direct links between requirements, design models and documnetation. So if we write design and V&V documents (in latex) we have to refer to requirements. This reference is usually done by giving the human readable requirement ID. As the human readable ID is not the unique identifier, we though it would be a nice add-on, if we could use a "link" in our latex documents, which can directly link to ProR requirements (and maybe SysML elements). In this case the verifier can only hit the link in the compiled pdf, which reduces the time to verify design decisions.

cecilebraun commented 10 years ago

For a first step, does using the same identifier in the tex file and the rest of the toolchain will be enough. We could easily make copy and paste feature from ProR to text document.

cecilebraun commented 10 years ago

@janWelte What do you think ?

janWelte commented 10 years ago

Without any deeper discussion, I think this could very well be a first solution. We can only give you more specific requirements, when we see how the design team actually sets traces, as this step is still laking in most design artifacts.

morido commented 9 years ago

A clean solution would be a TeX-export from ProR which attributes labels to each requirement. And then use xr to reference those. Should not be hard to do that... (and as a nice side effect one would also get a nice TeX-formatted version of subset026). Downside is that there wont be any link from the TeX back to reqif (other than "knowing" both are equivalent since the former is generated from the latter).

jastram commented 8 years ago

@raphaelfaudou - I assume we can close this too?