Skip to content
This repository has been archived by the owner on Sep 24, 2019. It is now read-only.

Simplify assessment titles / descriptions #353

Open
mlewand opened this issue Jun 25, 2015 · 1 comment
Open

Simplify assessment titles / descriptions #353

mlewand opened this issue Jun 25, 2015 · 1 comment

Comments

@mlewand
Copy link
Member

mlewand commented Jun 25, 2015

Hey, what do you think about making assessment titles / descriptions more understandable for non-technical person.

I'm talking about avoiding HTML tags / attributes usage where it's possible.

Examples

Instead:
All "alt" attributes for <code>img</code> elements should be clear and concise. "Alt" attributes over 100 characters long should be reviewed to see if they are too long.
Use:
Image alternative text shouldImage alternative text should be clear and concise. Alternative text longer than 100 characters should be reviewed to see if it can be shortened.

Instead:
Use the ordered (<code>ol</code>) or unordered (<code>ul</code>) elements for lists of items, instead of just using new lines which start with numbers or characters to create a visual list.
Use:
Use the ordered or unordered (bulleted) list elements to mark lists instead of using new lines that start with numbers or other characters to create a visual list.

Examples

We started to work on this in cksource#13 so you can see other examples there.

@jessebeach
Copy link
Member

Sure, I back this. Let's do it. I'm always in favor of simpler language.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants