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

Is 'Keep it short and simple' too vague? #29

Closed
iadawn opened this issue Jun 15, 2015 · 8 comments
Closed

Is 'Keep it short and simple' too vague? #29

iadawn opened this issue Jun 15, 2015 · 8 comments

Comments

@iadawn
Copy link

iadawn commented Jun 15, 2015

Refers to Keep content short and simple tip in 'Writing'.

The tip had referenced the KISS (Keep it simple, stupid) principle which is a common adage in design. The 'it' in this case may be too vague to be helpful?

@sharronrush
Copy link

No it is not too vague to be helpful as a "Tip." In fact, it perfectly models what it advocates by being short and simple itself.

@melodyma
Copy link

"Keep content short and simple" it straight forward and self explanatory.

@AndrewArch
Copy link

agree

@hkramer
Copy link

hkramer commented Jun 25, 2015

Prefer "keep content short and simple"

@shawna-slh
Copy link
Contributor

hummm.... a few points on this:

  • While "it" is ambiguous, that's probably OK for the tip text, since it's explained in the explanation. [I don't feel strongly on this.]
  • I think "content" is jargony in this context. Perhaps it could be "Keep writing short and simple"? [I feel medium against "content".]
  • It is pretty redundant with the next point "Avoid using overly complex words and phrases". Maybe these ought to be combined , or further differentiated?
  • I think this needs a qualifier -- something along the lines of "as appropriate for the context". In some cases, e.g., academic, short is not a goal. [I feel kinda strong on this point.]

/me teases Kevin on this -- we need to "eat own dog food" on with this one! -- it's kinda like tersify! ;-)

@bakkenb
Copy link

bakkenb commented Jun 25, 2015

I agree with Shawn about the qualifier. Sometimes the intent of web content is not to keep it short and simple but to give very detailed information when teaching about something, for example the WCAG 2.0 page is not to be kept short and simple.

I think we an use "Keep it Short and Simple". This is in the writing section of tips, so people should know "it" is about the writing/content of the web pages.

@schantzwebconsulting
Copy link

My initial thought is to remove this because it suggests "dumbing things down" or imposing a newspaper's editorial writing style. Upon further reflection, I think this advice is for making all content more accessible, and should be kept.

iadawn added a commit that referenced this issue Jun 26, 2015
[EOWG Meeting 26
Jun](http://www.w3.org/2015/06/26-eo-minutes.html#item03): Resolved to
add qualifier to initial sentence in tip to mention context.
@iadawn
Copy link
Author

iadawn commented Jun 26, 2015

EOWG Meeting 26 Jun: Resolved to keep a form of 'Keep content short and simple'. Further discussion lead to alternative suggestions captured in #42.

EOWG Meeting 26 Jun: Resolved to add qualifier to initial sentence in tip to mention context.

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