[wp-docs] The main page.

m3shrom m3shrom at riseup.net
Mon Aug 29 21:23:16 UTC 2011


On 29/08/2011 21:40, Spencer Hill wrote:
> m3shrom, can you explain what the flossmanuals is? And what the booki links are? Maybe I'm just a newby, but I don't know what you're talking about there.

Sure - There's more info here. http://blog.booki.cc/
and here - http://en.flossmanuals.net/index.php?plugin=blog - click on
the on the about tab.

> If we move forward with the task based approach, how can we ensure there isn't confusion like this?

I think that's a good question. If you are aiming to have step by step
instructions getting this kind of clarity can be tricky.

Personally, I've struggled in working on docs which are targeted at
people using
- their own install
- Wordpress.com
- a blog on a hosted WordPress network

For Codex / Manual docs it should be easier, you just need to add in
different possibilities for users with different levels of access. For
the example you use it could be...

"The first thing you need to log in is a Username and Password. If you
set up your own WordPress site then you should have them to hand. If
someone else set up the site, they may have added you as a user and
notified you in an automatically generated email. It should have the
title Your Username and Password."

@Lorelle - I don't know that guy / site. I just forwarded it for info. I
think that this is a very interesting comparing different kinds of docs,
when it comes to user focused, task based guides, it seems like often
the key skill is not completeness, it's the opposite, knowing what to
leave out.

That's guys guide was only 28 pages long including screenshots, which
gives a quick look at what he thought was most useful.


More information about the wp-docs mailing list