Skip to content

word order "W3C Group Draft Note" -> "Draft W3C Group Note" #779

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

Closed
shawna-slh opened this issue Aug 21, 2023 · 28 comments
Closed

word order "W3C Group Draft Note" -> "Draft W3C Group Note" #779

shawna-slh opened this issue Aug 21, 2023 · 28 comments
Labels
Closed: Accepted The issue has been addressed, though not necessarily based on the initial suggestion Type: Editorial improvements

Comments

@shawna-slh
Copy link

shawna-slh commented Aug 21, 2023

In working on messaging a new "W3C Group Draft Note", I struggle with parsing the words in that order. And I think "Draft" -- which is super important -- gets lost in that order.

May I suggest that we consider changing the word order?

best for clarifying draft status:

Draft W3C Group Note

also OK I think:

W3C Group Note Draft

@fantasai
Copy link
Collaborator

fantasai commented Aug 21, 2023

would “W3C Draft Group Note” work? Because I think that's a better title than the current “W3C Group Draft Note” which is actually kind-of awkward... and it's just a templating fix to do that.

(Fwiw, the Process defines Note aka Group Note, and Draft Note, but not Draft Group Note or Group Draft Note--so the ordering of Group vs Draft is a tr-design/specberus issue.)

W3C Group Note Draft is also possible, but then we'd want to define “Note Drafts” rather than “Draft Notes” as currently, and I think that sounds slightly less comfortable? But can live with it.

@shawna-slh
Copy link
Author

shawna-slh commented Aug 21, 2023

Thanks for stepping in @fantasai and @frivoal

I think "W3C Draft Group Note" is a only little better. I still think best is if Draft is first or last word.

but then we'd want to define “Note Drafts” rather than “Draft Notes” as currently, and I think that sounds slightly less comfortable

I think what is most important is clearly communicating "Draft" in the actual TR documents and the messaging that goes out to those not as familiar with W3C terminology.
image

Word order in the Process doc is less important, IMHO.

@koalie
Copy link
Contributor

koalie commented Aug 23, 2023

The core concept is "W3C Group Note" (because it's a note from a W3C Group), so my preference is to put "Draft" first or last, but not to break apart "W3C Group Note".

I have a stronger preference for:

Draft W3C Group Note

@fantasai
Copy link
Collaborator

@koalie The problem with that is that all of our statuses currently follow the pattern "W3C [STATUS]". We should not break that pattern for draft notes only.

@dwsinger
Copy link
Contributor

Aren't there at least 3 components to the name: W3C (who it comes from), note/recommendation/etc. (what it is), Draft/candidate/etc (what its status is)?

Yes, we tend to leave off some of these some of the time, e.g. we call things Working Draft when they are WDs of Recommendations.

Whether we need to do a wholesale renaming of concepts in order to get a consistent order and put back elided words I rather doubt...

@plehegar plehegar modified the milestones: Deferred, P2024 Sep 27, 2023
@fantasai fantasai added Agenda+ Marks issues that are ready for discussion on the call and removed Needs proposed PR labels Dec 12, 2023
@frivoal
Copy link
Collaborator

frivoal commented Dec 12, 2023

I wonder if we'd be better of simply dropping the word "Group" from this. Not sure it's buying us very much. "W3C Draft Note"?

@fantasai
Copy link
Collaborator

fantasai commented Dec 12, 2023

We could just go through and put "Draft" at the end for all things Draft. The oldest statuses (WD and CRD) already do this, so it'd just be a change to "Note Draft" and "Registry Draft" etc. to make them consistent.

@dwsinger
Copy link
Contributor

yes, beginning or end of the final name is good

@csarven
Copy link
Member

csarven commented Dec 13, 2023

"Draft" at the end is both readable and works with most common template/order (W3C ).

@frivoal
Copy link
Collaborator

frivoal commented Jan 25, 2024

Made PR #819 to implement what seems to be the leading solution to this issue.

@chrisn
Copy link
Member

chrisn commented Jan 25, 2024

I dislike putting Draft at the end, it reads backwards, W3C Draft Group Note would be the most natural for native English speakers.

@nigelmegitt
Copy link
Contributor

@chrisn I think it may sound better to prefix names with draft, but adding it as a suffix isn't too bad, and has the significant benefit of consistency with Working Draft, Editor's Draft (arguably an exception to the pattern because it's the only one whose name appears to assign ownership), CR Draft, Patent Review Draft and Discontinued Draft. On balance my view is that Note Draft and Registry Draft are acceptable names. In some ways the slightly awkward formulation of the name helps draw attention to the status.

@chrisn
Copy link
Member

chrisn commented Jan 25, 2024

I'd personally prioritise readability over consistency, but don't want to block things if you're all in agreement.

@TallTed
Copy link
Member

TallTed commented Jan 25, 2024

I strongly prefer the prefix form to the suffix form. Addressing the examples above....

  • To my mind, Working Draft, Editor's Draft, Patent Review Draft, and Discontinued Draft are truncations of the prefix form, and all could benefit from added suffixes indicating the document types of which they are Drafts (e.g., CR, PR, Note, Registry, etc.). I think leaving those document type suffixes off of these names actually amounts to an error, because a stack of Editor's Drafts could easily include (and mix up) Notes, CRs, Registries, and more.

  • CR Draft is easily transformed to Draft CR, which I think more clearly conveys its intended meaning.

  • Draft W3C Group Note, Draft W3C Note, Draft Group Note, and even Draft Note, all read clearly to me.

@frivoal
Copy link
Collaborator

frivoal commented Jan 25, 2024

What I like about the suffix form (in addition to consistency) is that it puts emphasis with the word Draft. Since we do seem to have a bit of a challenge with people thinking that anything coming out of w3c is a standard, highlighting that no, not everything is, and "this isn't a blablablabla, it's a blablablabla DRAFT", seems useful.

Now, that's my preference, but it's not a topic I don't care overly strongly about, and I can live with most any arrangement, including no change.

@TallTed
Copy link
Member

TallTed commented Jan 26, 2024

[@frivoal] What I like about the suffix form (in addition to consistency) is that it puts emphasis with the word Draft.

I think consistency can be achieved with either prefix DRAFT blablablabla or suffix blablablabla DRAFT.

I also think that English is generally read to have emphasis placed on the first word in a compound name, not on the last -- DRAFT blablablabla vs blablablabla draft.

I also think that there's no perfect answer. Sadly.

@nigelmegitt
Copy link
Contributor

Another thought about achieving consistency and a logical approach: we tend to omit mention of who "owns" the document in question, usually because there only seems to be one option, which is the (Working) Group. However in the case of an Editor's Draft, we include it. In the case of a Draft Statement we don't say something like "W3C Draft Statement", again because we take it that the only "group" that can publish a Statement is W3C.

So we have three explicit dimensions:

  1. Who owns it?
  2. Is it a Draft?
  3. What Maturity Level is it?

In a complete naming schema we maybe would include all three. I think the best order is the one I just listed above. Switching Draft to be at the end would also work, but the owner has to come first I think.

E.g. Editor's Draft Note, WG Draft CR, etc.

Maybe there's a case for a "shortened" form where the owner is implicit.

@frivoal
Copy link
Collaborator

frivoal commented Feb 29, 2024

I think consistency can be achieved with either prefix DRAFT blablablabla or suffix blablablabla DRAFT.

Yes, but that would mean renaming many things, which I don't think is advisable.

@frivoal
Copy link
Collaborator

frivoal commented Feb 29, 2024

@nigelmegitt I don't favor your proposal for two reasons:

  • that would mean renaming many things
  • having the word Draft in the middle, while a very natural phrasing, is the least noticeable / emphatic placement of the word Draft, and I think that it would be preferable to highlight it instead.

@nigelmegitt
Copy link
Contributor

Both concerns make sense to me @frivoal . I already noted that putting Draft at the end would work for me.

If we are considering any change to the naming scheme then it could imply renaming many things. When considering if it's worth bothering with such a change, this issue needs to be taken into account. However instead of requiring a mass rename we could consider:

  • adopting the new name scheme for new documents only
  • specifying a default mapping from old name scheme to new name scheme, so people can understand where historical documents would fit in the new scheme, without actually changing any of those historical documents.

@TallTed
Copy link
Member

TallTed commented Mar 13, 2024

My last point: English generally puts adjectives before the noun they modify; Draft is more "natural" than Draft.

This ordering is different in other languages.

@fantasai
Copy link
Collaborator

Last meeting we resolved to do one of:

Taking a straw poll here: pick your favorite via GH reaction?

@dwsinger
Copy link
Contributor

Yes. The alternatives seem to insert the word "draft" into the middle of the string that is the document type/name, and that's wrong.

@shawna-slh
Copy link
Author

Yes. The alternatives seem to insert the word "draft" into the middle of the string that is the document type/name, and that's wrong.

Well, my preference (from the top of this issue), is to put Draft first. Though I'm OK with last.

@frivoal
Copy link
Collaborator

frivoal commented Mar 28, 2024

The straw poll is limited to two options because other alternatives faced objections.

@TallTed
Copy link
Member

TallTed commented Mar 28, 2024

Consistency, even if it's not my favorite, is preferable to the status quo.

@css-meeting-bot
Copy link
Member

The Revising W3C Process CG just discussed Consistency of Maturity Stages wrt placement of "Draft", and agreed to the following:

  • RESOLVED: Adopt PR 819
The full IRC log of that discussion Subtopic: Consistency of Maturity Stages wrt placement of "Draft"
github: Consistency of Maturity Stages wrt placement of "Draft"
github: https://github.com//issues/779#issuecomment-2021822148
s/github: Consistency of Maturity Stages wrt placement of "Draft"//
florian: We narrowed to 2 options, and took a poll. 8 in favor of adopting, 1 in favor of doing nothing
... ChrisN, do you object to adopting? Preference seems clearly the other way around.
cpn: Mildly dislike. "Note Draft" reads awkwardly, and I'm OK with the word being in different places. But won't object.
florian: I think 8-1 and no objection means we do it
plh: unsure what it means for our publication system
florian: We're not changing many of them
... and not adopting just yet
... if it's a major challenge for systeam can reopen
plh: ok, lets agree to adopt, and I'll fyi to webmaster
RESOLVED: Adopt PR 819
-> https://github.com//pull/819

@css-meeting-bot css-meeting-bot removed the Agenda+ Marks issues that are ready for discussion on the call label Apr 24, 2024
@frivoal frivoal added the Closed: Accepted The issue has been addressed, though not necessarily based on the initial suggestion label Apr 24, 2024
@frivoal
Copy link
Collaborator

frivoal commented Apr 24, 2024

resolved by merging #819

@frivoal frivoal closed this as completed Apr 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Closed: Accepted The issue has been addressed, though not necessarily based on the initial suggestion Type: Editorial improvements
Projects
None yet
Development

No branches or pull requests