Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Dev/improve requirements #14

Merged
merged 5 commits into from
Jul 4, 2024
Merged

Dev/improve requirements #14

merged 5 commits into from
Jul 4, 2024

Conversation

wucke13
Copy link
Collaborator

@wucke13 wucke13 commented Jun 28, 2024

Pull Request Overview

This pull request adds strictdoc based requirements

Testing Strategy

This pull request was tested running strictdoc

TODO or Help Wanted

This pull request still needs agreement or disagreement on using strictdoc as a requirements engineering tool.

Formatting

  • Ran cargo fmt
  • Ran cargo check
  • Ran cargo build

Author

Signed-off-by: wucke13 [email protected]

@valexandru
Copy link
Collaborator

What are the advantages of using strictdoc? On some other projects on our side we use Sphinx Needs and I remember hearing that you also use this tool on some other projects on your side.

@wucke13
Copy link
Collaborator Author

wucke13 commented Jun 28, 2024

Advantages

  • purely textual representation, merge conflict friendly, versionable
  • simple format
  • export to html, json, even excel
  • easy to use web-editor
  • better than markdown
  • zero setup effort (compared as to sphinx needs for example)

I have not used Sphinx Needs myself. I suggest we discuss this in the next call, strictdoc is no necessarily better than Sphinx Needs (I for one wouldn't know), however it is better than Markdown.

@wucke13 wucke13 force-pushed the dev/improve-requirements branch from 5591df9 to 59ed48e Compare July 3, 2024 09:34
@wucke13 wucke13 force-pushed the dev/improve-requirements branch from 59ed48e to f7bbc8b Compare July 3, 2024 09:50
@wucke13 wucke13 enabled auto-merge July 3, 2024 14:39
@wucke13 wucke13 added this pull request to the merge queue Jul 4, 2024
Merged via the queue into main with commit b4021bb Jul 4, 2024
4 checks passed
@wucke13 wucke13 deleted the dev/improve-requirements branch August 15, 2024 08:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants