This might be slightly off topic but... As I see it, if we're generating HTML5 output, we're making a type of website with our documents. User Experience design should probably be considered. I think I've heard others mention it.
But, I'm having trouble finding reference books that discuss UX in the context of documentation. Does anyone have any favourites or links to share?
UX guidance for web-based outputs
-
BedfordWriter
- Sr. Propeller Head
- Posts: 231
- Joined: Wed Jun 23, 2010 10:13 am
- Location: Nova Scotia
-
kwag_myers
- Propellus Maximus
- Posts: 810
- Joined: Wed Jul 25, 2012 11:36 am
- Location: Ann Arbor, MI
Re: UX guidance for web-based outputs
I was thinking of starting a thread on this very topic. I'm currently on a project where both the Design Team and the Project Manager insist on creating a "User Experience". When they say it, I think of my childhood days at camp sitting by the fire singing songs together. All these years I've been under the impression that users wanted "information". But to your point, I agree that we must keep the user in mind and understand what it is they expect when they launch Help.
I've been collecting some sites on navigation, albeit not specifically to documentation. But I think there are some take-aways. I found it interesting that, of the first two blogs I read, there was a sharp disagreement on Drop Down Menus. Here's what I have so far:
I've been collecting some sites on navigation, albeit not specifically to documentation. But I think there are some take-aways. I found it interesting that, of the first two blogs I read, there was a sharp disagreement on Drop Down Menus. Here's what I have so far:
- Are You Making These Common Website Navigation Mistakes?
- 6 Website Navigation Best Practices
- Website Navigation Best Practices
"I'm tryin' to think, but nothin' happens!" - Curly Joe Howard
-
BedfordWriter
- Sr. Propeller Head
- Posts: 231
- Joined: Wed Jun 23, 2010 10:13 am
- Location: Nova Scotia
Re: UX guidance for web-based outputs
Thanks for the contribution. I look forward to reading the information at those links.
I've collected a few as well:
http://www.uxmatters.com/mt/archives/20 ... design.php
http://greyfiti.wikidot.com/sdg:gmeth-c ... umentation
And, there are several invaluable blogs, including http://idratherbewriting.com and http://www.cherryleaf.com/blog/
But, so far as I can see, most UX-related books are about website design, not documentation. There's probably a lot that websites and documentation (especially HTML5 documentation) have in common. I guess that I'm looking for a tidy package (read, "book") rather than searching through dozens of blogs.
Further suggestions welcomed.
I've collected a few as well:
http://www.uxmatters.com/mt/archives/20 ... design.php
http://greyfiti.wikidot.com/sdg:gmeth-c ... umentation
And, there are several invaluable blogs, including http://idratherbewriting.com and http://www.cherryleaf.com/blog/
But, so far as I can see, most UX-related books are about website design, not documentation. There's probably a lot that websites and documentation (especially HTML5 documentation) have in common. I guess that I'm looking for a tidy package (read, "book") rather than searching through dozens of blogs.
Further suggestions welcomed.
-
kwag_myers
- Propellus Maximus
- Posts: 810
- Joined: Wed Jul 25, 2012 11:36 am
- Location: Ann Arbor, MI
Re: UX guidance for web-based outputs
Do you mean, like DITA?
"I'm tryin' to think, but nothin' happens!" - Curly Joe Howard
-
BedfordWriter
- Sr. Propeller Head
- Posts: 231
- Joined: Wed Jun 23, 2010 10:13 am
- Location: Nova Scotia
Re: UX guidance for web-based outputs
Not really. I see DITA as a good way of organizing content, especially for larger organizations. But, from what I've been able to find, the tools available for presenting that well-organized information don't do nearly as good a job as Flare.
Proper organization is vital, but my interest at the moment is in the theory behind presenting information the best way possible. Content, organization, visual clues and more all come into it.
Maybe, "Don't Make Me Think" by Steve Krug comes the closest? Still hoping for more suggestions for books that blend UX and documentation.
Proper organization is vital, but my interest at the moment is in the theory behind presenting information the best way possible. Content, organization, visual clues and more all come into it.
Maybe, "Don't Make Me Think" by Steve Krug comes the closest? Still hoping for more suggestions for books that blend UX and documentation.