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

Simplifying language and shortening sections [TAG feedback - editorial] #815

Open
rhiaro opened this issue Jul 25, 2022 · 1 comment
Open
Labels
defer to arch 2.0 tag-needs-resolution Issue the Technical Architecture Group has raised and looks for a response on.

Comments

@rhiaro
Copy link
Member

rhiaro commented Jul 25, 2022

From an editorial perspective, implementers who are approaching this set of specifications for the first time may be deterred by the volume of text. In particular where sections or paragraphs do not relate to specific, implementable requirements. The specification abstracts are all rather long and we think all of the specs would benefit from a thorough proof-read, with an eye to removing redundant text, simplifying language, removing filler, and overall shortening throughout. While background and context are useful, we would encourage containing such sections in their own documents, which may be optionally read, and keeping only the informative language that is really crucial for implementation in the specifications themselves.

(from w3ctag/design-reviews#736)

@mlagally mlagally added tag-needs-resolution Issue the Technical Architecture Group has raised and looks for a response on. address TAG feedback and removed tag-needs-resolution Issue the Technical Architecture Group has raised and looks for a response on. address TAG feedback labels Aug 4, 2022
@mlagally
Copy link
Contributor

mlagally commented Oct 13, 2022

Arch call on Oct 13.:
The current architecture document introduces multiple other documents that were created by the WoT group. There are multiple implementations of the specification, examples of applications are available for plugfests, testfests.
A reader can skip the informative sections and review the normative parts only.

We will revisit this feedback in the next charter of the WoT working group.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
defer to arch 2.0 tag-needs-resolution Issue the Technical Architecture Group has raised and looks for a response on.
Projects
None yet
Development

No branches or pull requests

3 participants