proposed structure#16
Open
categulario wants to merge 1 commit into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The proposed new structure.
Important details
Section numbers are removed
If KDF and functional requirements are merged, all the numbers change. From what I've seen these numbers are used to refer to the chapters, but any change in the amount of chapters can break this. Therefore I propose to stick to using the charper names to refer to them instead of the numbers (which I find very confusing btw). Less abstraction layers closes the gap to understanding.
Functionalities are placed one per file, with a yaml file for requirements.
This is part of the effort to make then machine-readable.
KDF and Functional requirements are merged
According to the introductory text for KDF in this very repo KDF would be the required requirements. That can easily be expressed by the requirement level.