nuts-foundation / nuts-foundation/nuts-node

Controlling use case quality

Open
#4,146 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
28
Forks
23
Avg merge
1d 10h
Merged PRs (30d)
76

Description

Use cases are designed and documented by a lot of people. This leads to non-homogenous specifications, some being high-quality and others of different quality. We should take measures to help use case designers/specifiers make quality use cases and resources.

This could be in any form, e.g. (or a combination of those):

  • A group within the Nuts community that assesses use case quality
  • A checklist of things to keep in mind when designing use cases
    • e.g.: scope design, authorization policies
  • A model to follow (find other vendors, define goals, look for information standards, PoC/hackaton, assess, implement, pilot, etc)
  • I started a Wiki book on this at some point: https://wiki.nuts.nl/books/designing-a-nuts-use-case (incomplete)
  • Tooling that helps checking formal specification

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the incomplete Designing a Nuts use case wiki book linked in the issue and compare it with the proposed checklist, quality-assessment group, lifecycle model, and formal-specification tooling options. No code files or tests are named; the work is complete only after the community agrees on a concrete quality approach and its supporting resources.

Written by the indexing model from the issue text.

Assessment

Domain
content, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.