Coder Social home page Coder Social logo

Comments (26)

fantasai avatar fantasai commented on June 16, 2024 10

Last meeting we resolved to do one of:

  • 👍 Do nothing
  • ❤️ Adopt PR #819 to put "Draft" at the end for Note and Registry tracks.

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

from w3process.

koalie avatar koalie commented on June 16, 2024 4

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

from w3process.

TallTed avatar TallTed commented on June 16, 2024 2

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.

from w3process.

shawna-slh avatar shawna-slh commented on June 16, 2024 1

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.

from w3process.

csarven avatar csarven commented on June 16, 2024 1

"Draft" at the end is both readable and works with most common template/order (W3C <document-type> <status>).

from w3process.

chrisn avatar chrisn commented on June 16, 2024 1

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

from w3process.

TallTed avatar TallTed commented on June 16, 2024 1

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

from w3process.

fantasai avatar fantasai commented on June 16, 2024

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.

from w3process.

fantasai avatar fantasai commented on June 16, 2024

@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.

from w3process.

dwsinger avatar dwsinger commented on June 16, 2024

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...

from w3process.

frivoal avatar frivoal commented on June 16, 2024

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"?

from w3process.

fantasai avatar fantasai commented on June 16, 2024

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.

from w3process.

dwsinger avatar dwsinger commented on June 16, 2024

yes, beginning or end of the final name is good

from w3process.

frivoal avatar frivoal commented on June 16, 2024

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

from w3process.

chrisn avatar chrisn commented on June 16, 2024

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

from w3process.

nigelmegitt avatar nigelmegitt commented on June 16, 2024

@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.

from w3process.

frivoal avatar frivoal commented on June 16, 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.

from w3process.

TallTed avatar TallTed commented on June 16, 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.

from w3process.

nigelmegitt avatar nigelmegitt commented on June 16, 2024

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.

from w3process.

frivoal avatar frivoal commented on June 16, 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.

from w3process.

frivoal avatar frivoal commented on June 16, 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.

from w3process.

nigelmegitt avatar nigelmegitt commented on June 16, 2024

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.

from w3process.

TallTed avatar TallTed commented on June 16, 2024

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

This ordering is different in other languages.

from w3process.

dwsinger avatar dwsinger commented on June 16, 2024

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.

from w3process.

shawna-slh avatar shawna-slh commented on June 16, 2024

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.

from w3process.

frivoal avatar frivoal commented on June 16, 2024

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

from w3process.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.