I wasn't sure if you wanted to create a new issue for this - moofie recommended making a new issue. I did the same thing to "List Users by Role" help info as I did with the other.

I reduced the steps, and grouped similar tasks, added minute clarifications. This required a small amount of rearranging, but overall it has the effect of making more sense, and reducing the "cognitive load" as they like to say.

See what you think...

CommentFileSizeAuthor
#5 example-users-by-role.txt5.86 KBmooffie
#4 example-users-by-role.txt6.36 KBmooffie
#1 example-user-list3.txt5.94 KBheather
example-user-list2.txt5.98 KBheather

Comments

heather’s picture

heather commented
StatusFileSize
new example-user-list3.txt5.94 KB

oops. i missed the changes of strong -> h3 for the task section headings. i have revised that here to save you the trouble.

i wasn't sure you could use header tags within a list... but it validates!

merlinofchaos’s picture

merlinofchaos commented
Status: Active » Needs review

This isn't technically a patch but for the help system I'm ok with that but marking it patch (cnr) will hopefully get more 3rd party reviews of the text.

mooffie’s picture

mooffie commented
Assigned: Unassigned » mooffie

(I'm reviewing this. I'll return in an hour or two.)

mooffie’s picture

mooffie commented
Assigned: mooffie » Unassigned
Status: Needs review » Reviewed & tested by the community
StatusFileSize
new example-users-by-role.txt6.36 KB

Heather, excellent work! The intro is nice.

I'm attaching a refined version, the same treatment I gave to the other HowTo.

Merlin,
After you apply the other HowTo's patch (the "recent stories" one), overwrite its "example-users-by-role.html" with this new file (this new file has a '.txt' extension because D.O. wouldn't let us upload an '.html' file).

mooffie’s picture

mooffie commented
StatusFileSize
new example-users-by-role.txt5.86 KB

Oops. I didn't notice it's the same intro that's already in 'getting-started.html' (Your works is excellent nevertheless, Heather ;-). I'm attaching the updated file, with that intro removed (but there's still an intro paragraph).

mooffie’s picture

mooffie commented

Merlin, I've just posted a "mega patch" in the other HowTo's issue that combines these two HowTo's. I thought perhaps you may find it easier if the two are in a single patch. If so, you'd want to close this issue you're now reading.

merlinofchaos’s picture

merlinofchaos commented
Status: Reviewed & tested by the community » Closed (fixed)

mooffie, I agree. Will deal with this in the other issue.