-
Notifications
You must be signed in to change notification settings - Fork 4
Add Audience section #25
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
Merged
Merged
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the last sentence is overstepping:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"Technical authors" is intentional. It covers both spec writers as well as anyone generally contributing to specification development. But it also includes anyone that is writing a document (not necessarily a "spec") that needs to refer to these concepts.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What about "technical writers"?
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That could work too. My interpretation is that "technical authors" is a bit broader and also covers "technical writers". Authors captures spec writers, standards contributors, and generally anyone defining or referencing technical documentation, including writers of docs/guides/manuals for users and other developers. Besides, I think the definition here is adequate.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Either writers or authors works for me. Marcos also made at least two other suggestions in his patch, and it would be good to resolve that too. I don't feel strongly about either, but:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not super comfortable... no one us are lawmakers or lawyers and I worry it will come back to bite us in the 🍑.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jyasskin , ack!
@marcoscaceres , bite us how?
Aside: If there's an argument for including web developers as an audience, there's at least as strong a case for including regulators, since both can benefit from understanding these principles.
To be clear, this document sets technical and ethical duties, not legal obligations. It can serve as a reference for understanding web community expectations but is not intended as binding or advisory law. We can improve it to avoid ambiguity that might lead to misinterpretation.
I'd argue that the TAG/W3C should take this opportunity to rise to the occasion, so to speak.
I've updated the definition based on above to clarify but if that's not aligned with our goal, am completely open to discuss.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I thought "in the manner described in this document" is redundant. It's already implied by the section, and there's nothing else it could refer to.
I really like the proposed "prioritize their users" because it signals the user-centric duty up front. Also aligns with the priority of constituencies.