threagile icon indicating copy to clipboard operation
threagile copied to clipboard

Create more documentation regarding tech/protocol types, diagram color legend, and usage of schema json etc.

Open cschneider4711 opened this issue 4 years ago • 3 comments

This issue is to track the creation of aforementioned documentation

cschneider4711 avatar Feb 07 '21 11:02 cschneider4711

Hi, I was wondering where is the documentation regarding the protocol types? I'd also be interested to know more about how the different types of authorization for technical asset is defined and used? thanks.

chujiaoma avatar Mar 22 '22 04:03 chujiaoma

It'd also be super useful to know which fields and values have what kind of implication on the output. Like, how does the output change if I change confidentiality from internal to restricted, or doesn't that make a difference at all?

dAnjou avatar Jun 02 '22 09:06 dAnjou

First part of docs have been added via recent PRs (thx to @Thorsten-Sick ) and direct commits: Now several explanation switches on the CLI can be used to list these (basic still) explanations:

  -explain-model-macros
        Detailed explanation of all the model macros
  -explain-risk-rules
        Detailed explanation of all the risk rules
  -explain-types
        Detailed explanation of all the types

... each of them returning the details in the console then.

cschneider4711 avatar Nov 04 '23 15:11 cschneider4711