dubhain: (Default)
The Cat Whisperer ([personal profile] dubhain) wrote in [site community profile] dw_docs2011-04-02 12:42 am
  • Add Memory
  • Share This Entry
  • Current Mood: amused
  • Current Location: Left-sideways-down

SMOG Calculator

(Because I'd like to make my debut post with something useful:)

As DW's style manual states that FAQs should have a readability of 8.0-9.0 on the SMOG Readability Scale, and because I really hate trying to calculate such things manually, I refer anyone interested to: The SMOG Calculator.

Also? O hai, everyone.

(Ducks, to avoid bricks and brickbats being thrown at him for the heinous use of lolspeak in a [site community profile] dw_docs post.)
Flat | Top-Level Comments Only
denise: Image: Me, facing away from camera, on top of the Castel Sant'Angelo in Rome (Default)

[staff profile] denise 2011-04-02 05:40 am (UTC)(link)
Yeah, that's one of the ones that we're going to really go over with a fine toothed comb. It's got a lot of very technical information to shoehorn in!

I think the best approach to that one is maybe to break it up with some bolded headings or something? That way the eye doesn't see AUUUGH WALL OF TEXT. Or maybe even some illustrations, of the settings pages or whatever.
silverflight8: Barcode with silverflight8 on top and userid underneath (_support)

[personal profile] silverflight8 2011-04-02 05:43 am (UTC)(link)
Yeah, headings would help. It's also really just about one thing, so not great to split up into separate FAQs. There's also a lot of stuff that can be put into bullets, or even a simple table, I think.
denise: Image: Me, facing away from camera, on top of the Castel Sant'Angelo in Rome (Default)

[staff profile] denise 2011-04-02 05:49 am (UTC)(link)
*nod* I'm all for fancy formatting tricks to make a wall-o-txt into something more readable!
dubhain: (Default)

[personal profile] dubhain 2011-04-02 05:51 am (UTC)(link)
Obligatory statement of the obvious: Making sure, of course, they're compatible with mobile and accessibility devices.
denise: Image: Me, facing away from camera, on top of the Castel Sant'Angelo in Rome (Default)

[staff profile] denise 2011-04-02 05:54 am (UTC)(link)
Oh, yeah, totally. Semantic markup, yadda!
Flat | Top-Level Comments Only