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

DID CRUD is a confusing term #61

Closed
TzviyaSiegman opened this issue Dec 26, 2019 · 6 comments
Closed

DID CRUD is a confusing term #61

TzviyaSiegman opened this issue Dec 26, 2019 · 6 comments

Comments

@TzviyaSiegman
Copy link

I am reading the Use Case document while attempting to write a document that explains DID to people with a limited technical background.

Section 3 "DID Actions" is helpful, but I am confused by the introductory diagram and paragraph about "DID CRUD". I believe this attempts to group all actions into one of 4 categories and the diagram is supposed to explain to the reader where each of the actions described in section 3 falls. I think it would be much clearer to the reader to have subheadings explaining this.

(@jandrieu might recognize my attempts to kill all complicated diagrams from previous experiences working with me ). If the diagram remains, the alt text is not sufficient. It confused me, and I have no vision issues.

@TzviyaSiegman
Copy link
Author

one more point - the diagram shows the category "use", which is not part of the introductory text.

@philarcher
Copy link
Collaborator

Thanks Tzviya. PR 61 is my suggestion for how to fix this #73

@jandrieu
Copy link
Collaborator

jandrieu commented Apr 1, 2020

Thanks, @TzviyaSiegman Phil and I had a great chat about this today. He's going to take a stab at improving it.

One delightful complication is that we now have several new species of DID Methods for which even the assumptions made in the initial diagram fail. There is also the sloppy treatment of DIDs and DID Documents as "the same thing" when talking about CRUD: updating a DID means updating the DID Document, but presenting a DID is not the same as presenting the DID Document.

So, we need some work to clean this up. We'll let you know when there's something worth evaluating as a potential fix.

@selfissued
Copy link

Indeed, this is one of the important kinds of terminology cleanup needed across our document suite.

@peacekeeper
Copy link
Contributor

Quick note that we recently removed the term CRUD from the DID Core spec: w3c/did-core#226

@philarcher
Copy link
Collaborator

I wrote a PR for this on 1 April and there's been no further comment so I propose we accept the PR #73 and close this issue in the absence of any further input.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants