As developer, I should easily link any requirement identifier (e.g security, architecture, functional id) into software source code's documentation via annotation anywhere in code

[olivierlemee]

Goal & need: a link between an instruction, a method, a class or a rule implemented in a software source code should be linked to the cause that motivate is existence. For example, in a section of implemented rules of the software, a link to one or many REQ_XXXX, SEC_XXX, ARC_XXX requirements (e.g inventory of requirements manager in Notion) is mentioned in the source code via annotation like @why(requirement = { "REQ_XXX", "SEC_XXX", "ARC_XXX"}, threat = { "CVE_YYY", "CVE_ZZZ" }). The annotation should be visible in standard tool of language documentation (e.g javadoc, jsdoc).
A quality check (e.g convention, norm regarding level of documentation required) can be developed to control the level of documentation of source codes in terms of dependencies (for easy future maintenance) supporting future need of impact analysis based on requirements.

• create annotation reusable and common library per language
• create usage documentation in github documentation (sub-directory named "how-to" with readme.md, and sub-page named "coding-norms-and-conventions.md" including a model of description for each naming convention, and tagging norm) regarding the CYBNITY extended annotation library per language
• add mention in PURPOSE about the difference between norm (mandatory to apply and which can be controlled via quality check process, generating reject of source code for violation of documentation norm) vs convention (optional, without mandatory quality check, and that can be transformed in norm after a period)
• create test of the annotation (e.g on method, on instruction, into comments, on class, on parameter value where some links with requirements could exist) and check of visibility in standard generated documentation

FOR HELP
Java source code:

• user extended annotation definition : https://docs.oracle.com/javase/tutorial/java/annotations/declaring.html
• https://fr.wikibooks.org/wiki/Programmation_Java/Annotations

Javascript source code:

• https://developer.wordpress.org/coding-standards/inline-documentation-standards/javascript/
• https://jsdoc.app/
• https://www.section.io/engineering-education/jsdoc-documentation/