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

Clarify and simplify the sections regarding publication and process 2021 #700

Open
wareid opened this issue Jan 23, 2023 · 11 comments
Open
Assignees

Comments

@wareid
Copy link

wareid commented Jan 23, 2023

I am aware that previous issues have been opened regarding this (#589, #590), but I want to further expand and discuss the possibility of completely revising this section for readability.

Background: EPUB 3 WG is planning to vote this week to move the specification to PR. As part of this, we need to make the decision as to whether we want to make EPUB3 a "living standard" in the common parlance. To support my WG, I sent an email explaining what the difference is, but to make sure I was being accurate, I decided to do a close read of most of section 6, but specifically 6.3.

I cannot emphasize this enough, I am a native english speaker with a degree in English Literature and 5+ years of experience in standards including as an editor: this section is almost completely impossible to understand. I say almost because I was able to write my summary for the working group, as to whether it's helped anyone in making a decision, I have no idea.

I am not saying this to criticize anyone, but I do think we need to look at the following issues within the text and revise according. I am willing to help with this (I joined process CG so I'm on the hook).

  1. Address the terminology issues raised in issue Simplify Process 2021 (candidate|proposed) (change|addition|correction) terminology #590 - Manu provided an excellent simplification of the terminology to start from, and I had the same experience with confusion over the terminology.
  2. Clarify that there are 2 paths a new specification can take, and give proper naming to those (none of this "accepts new features" terminology, it's not a name).
  3. Create new visualizations for both pathways
  4. Clarify the types of changes (the levels system is actually quite clear, I think it just needs more prominence).
  5. Clarify revision process for older specifications that are not on the new process.
  6. Remove the circular references, many sections link back to each other and give the illusion of clarifying while somehow making things more confusing (related to Simplify Process 2021 (candidate|proposed) (change|addition|correction) terminology #590).

Chairs and editors for new specifications need to be able to explain this to their WGs and implement these changes, right now it's basically impossible.

@frivoal frivoal added this to the Deferred milestone Mar 2, 2023
@marcoscaceres
Copy link
Member

marcoscaceres commented Jun 30, 2023

@wareid, agree (also as someone with a BA specializing in semiotics and someone working on standards for ~15 years)... I tend to just drop sections of the Process into ChatGPT nowadays and ask it to explain it to me in plain English. It does a pretty good job :)

Half joking... maybe we should drop more of the Process into ChatGPT and get it to rewrite it into something more comprehensible.

@wareid
Copy link
Author

wareid commented Jun 30, 2023 via email

@nigelmegitt
Copy link
Contributor

I think it's fine to try this out and see what it comes up with, but I'd sound a strong note of caution: given how much time and brain power has been spent, mainly by the Editors, getting the words of the Process to say what we intend them to mean, I'd be very wary of a good sounding and maybe more readable version having unintended substantive changes.

@TzviyaSiegman
Copy link

Let's consider https://hemingwayapp.com/, which is geared toward readability instead of summarization. This is often used to ensure cognitive accessibility.

@dwsinger
Copy link
Contributor

There has been quite a lot of effort on re-organizing and limited re-writing over the last few years; we realized that the document had grown in an organic way and needed serious attention. I don't want to suggest that we're done, in any way.

Putting it through readability analysis is a great idea.

The caution is, of course, the usual rule (that applies in software too): if it works, leave it alone. If you edit, you may (actually, will) introduce bugs. But unreadability is also a bug.

@frivoal
Copy link
Collaborator

frivoal commented Jul 1, 2023

@wareid I agree with you that these specific sections of the Process are very complex and difficult. Unfortunately, this is not merely because the editorial style is complex. The underlying thing it is trying to handle is itself complex, and there are deliberate goals we're trying to uphold that result in this complexity.

I think it is absolutely worth out time to spend effort on trying to find ways to both simplify the underlying notions and clarify the text that describes it, but doing so without regressing on what this Process was trying to ensure is probably not going to be easy.

Even then, I think this is likely one of the top priorities for the next cycle of the Process.

@frivoal
Copy link
Collaborator

frivoal commented Jul 1, 2023

As for using tools to help, any inspiration we can get is great. I am a little skeptical that https://hemingwayapp.com/ will be of much help in this context. It seems more targeted at writing vivid prose than precise rules. I am also unsure of its advice when it comes to non-native speakers. For example, it says to avoid adverbs, and gives the following advice:

For instance, instead of saying that someone is “walking slowly” you can say they “tip-toed” or they “crept.” That way, your writing is more vivid.

This may be a good tip for writing an engaging novel, but I am quite certain that many more people are capable of understanding "walked slowly” than “tip-toed” or “crept" .

@marcoscaceres
Copy link
Member

marcoscaceres commented Jul 4, 2023

don't know about Hemingwayapp.com, but I'm sure it will find some things.

At the same time, with ChatGTP 4, remember you need to put it into "the right frame of mind" with the prompts. Like,

"Hey Chatty, set yourself to be an expert in international standards, and with the precision of a world class lawyer, and a PhD in Computer Science. I need you to analyze the following text from the W3C's Process document for clarity and precision. I'm a member of the W3C's Advisory Board, and we will be updating the W3C Process document together. As I copy and paste text for you, can you first identify ambiguities in the text and explain why. Then suggest a number of possible corrections. Where you need more context or you are missing definitions, please ask and I can provide them for you. Here is the text full text for the section we are updating:

[TEXT HERE]. 

I want you to analyze paragraph 3 and tell me what you think."

And then, you can ask it logical questions.

Hey Chatty, if X was to happen with Y, what would the outcome be based on the change we have agreed to?

And so on... hope that helps!

Oh, and you can also ask it to keep matching the writing style of the W3C Process document by providing it with sections that you find well written.

@marcoscaceres
Copy link
Member

marcoscaceres commented Jul 4, 2023

You will still need to edit and carefully review whatever it produces... but it should do a reasonable job at least identifying issues.

And I do encourage you to run simulations on various scenarios. Just to check that the logic is correct. If the prose is algorithmic in nature (if... then), you can even ask it to write the thing out in some formal language (even just JavaScript!) to check the logic with proof cases.

@TallTed
Copy link
Member

TallTed commented Jul 6, 2023

It's also important to use the latest version of ChatGPT you can. Paid accounts currently have access to 3.5 and 4.0. There's less difference in the output between these than there was between 3.0 and 4.0, but it's still substantial.

@plehegar plehegar modified the milestones: Deferred, P2024 Sep 27, 2023
@wareid
Copy link
Author

wareid commented Sep 27, 2023

I should have followed up earlier with the results of my little experiment on this but sadly, LLMs cannot handle the Process.

I attempted to get it to summarize several sections and it quickly lost context, often mangled the meaning of statements, and basically produced an unusable set of guidelines. It was an interesting exercise though!

frivoal added a commit to frivoal/w3process that referenced this issue May 1, 2024
This change gives a little bit more context about how to make normative
changes to a REC. Technically, and this is what the existing text talked
about, they are made by folding in candidate amendments. However,
someone just reading that section may not be aware of what candidate
amendments are and how they are made to begin with.

This gives just a little bit of context to help people piece things
together.

This is a small step towards addressing w3c#700
frivoal added a commit to frivoal/w3process that referenced this issue May 1, 2024
This change gives a little bit more context about how to make normative
changes to a REC. Technically, and this is what the existing text talked
about, they are made by folding in candidate amendments. However,
someone just reading that section may not be aware of what candidate
amendments are and how they are made to begin with.

This gives just a little bit of context to help people piece things
together.

This is a small step towards addressing w3c#700
frivoal added a commit that referenced this issue May 8, 2024
…#862)

This change gives a little bit more context about how to make normative
changes to a REC. Technically, and this is what the existing text talked
about, they are made by folding in candidate amendments. However,
someone just reading that section may not be aware of what candidate
amendments are and how they are made to begin with.

This gives just a little bit of context to help people piece things
together.

This is a small step towards addressing #700

Co-authored-by: Ted Thibodeau Jr <[email protected]>
frivoal added a commit to frivoal/w3process that referenced this issue May 8, 2024
Revising a REC is a fairly complicated piece of the Process. The 4
subsections that deal with making revisions for class 1 through 4 are
comparatively simple, but they had very strong similarities between
class 1 and 2, and class 3 and 4. Consolidating the text not only makes
the whole thing shorter, it also eliminates subtle differences of
language that could leave people wondering about potential differences
where none were intended or useful.

This is a small part in addressing w3c#700
frivoal added a commit to frivoal/w3process that referenced this issue May 21, 2024
Revising a REC is a fairly complicated piece of the Process. The 4
subsections that deal with making revisions for class 1 through 4 are
comparatively simple, but they had very strong similarities between
class 1 and 2, and class 3 and 4. Consolidating the text not only makes
the whole thing shorter, it also eliminates subtle differences of
language that could leave people wondering about potential differences
where none were intended or useful.

This is a small part in addressing w3c#700
frivoal added a commit to frivoal/w3process that referenced this issue May 21, 2024
Revising a REC is a fairly complicated piece of the Process. The 4
subsections that deal with making revisions for class 1 through 4 are
comparatively simple, but they had very strong similarities between
class 1 and 2, and class 3 and 4. Consolidating the text not only makes
the whole thing shorter, it also eliminates subtle differences of
language that could leave people wondering about potential differences
where none were intended or useful.

This is a small part in addressing w3c#700
frivoal added a commit to frivoal/w3process that referenced this issue May 21, 2024
Revising a REC is a fairly complicated piece of the Process. The 4
subsections that deal with making revisions for class 1 through 4 are
comparatively simple, but they had very strong similarities between
class 1 and 2, and class 3 and 4. Consolidating the text not only makes
the whole thing shorter, it also eliminates subtle differences of
language that could leave people wondering about potential differences
where none were intended or useful.

This is a small part in addressing w3c#700
frivoal added a commit that referenced this issue May 22, 2024
Revising a REC is a fairly complicated piece of the Process. The 4
subsections that deal with making revisions for class 1 through 4 are
comparatively simple, but they had very strong similarities between
class 1 and 2, and class 3 and 4. Consolidating the text not only makes
the whole thing shorter, it also eliminates subtle differences of
language that could leave people wondering about potential differences
where none were intended or useful.

This is a small part in addressing #700
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

No branches or pull requests

8 participants