[wp-docs] plugins page could use a touch-up

Lorelle on WordPress lorelleonwordpress at gmail.com
Thu Dec 1 21:10:44 UTC 2011


@Jane: Are there any other pages that will be directly linked from
WordPress 3.3 that need work? Can you add them to the docs task list blog
so we can make sure that all of them are covered? Thanks!

@Jan It looks great but I had no idea that it was such an octopus in
general, not just outgoing links. I just went through and pruned and
updated it with a vengeance, streamlining the entire thing and getting rid
of the redundancies. Most of your changes are probably still there, but I
fear my exuberance might have bulldozed them.

This is a hard one as I usually just offer tips and recommendations on
editing, but this one is an important document and needs to get the
information to the user NOW. More lists, less words, to the point. So I
took a hatchet to the whole thing.

We need updated images on this. Whoever wants to take that on (hint, hint,
Jan. :D ) have at it.

Jan and everyone, go through it with a fine tooth comb as I'm sure I missed
something or messed up some detail. I really hacked it good.

Some important points to note for future editing (and don't let this stop
you. All of those octopus links need checking and updating!!!):

* Plugin is a proper name, so it's capitalized (yeah search and replace!).

* Not always but when appropriate we use WordPress Plugin not Plugin to
boost the findability with SEO.

* We resist attempts to use HTML when formatting just about everything,
especially lists. I know it's a pain to learn wikispeak, but it's actually
fewer keystrokes than HTML.

* Watch the storytelling on such documents. This isn't for you but for us
all. There wasn't much, and I probably put it there years ago when we had a
story to tell, but I got rid of the stories to tighten it up to get to the
point: HOW DO I DO THIS NOW?

It's time for everyone to take a gander at this and make sure we've dotted
all the t's and crossed the i's.

Thanks!

Lorelle


On Wed, Nov 30, 2011 at 3:13 PM, Jan Cohen <najnehoc at yahoo.com> wrote:

> Okay, I've gotten far enough that, as this is my first Codex project, some
> of (or a lot of) you may want to have a gander at what I've done. There are
> still a couple of works in progress (WIPS), and I'm still finding my
> footings using wikispeak styling, but all in all, I think I'm getting
> there.
> Once this page is squared away, I think I'll have a look at the octopus
> associated with this specific page. It looks like it needs some loving care
> and attention:
>
> http://codex.wordpress.org/Managing_Plugins
>
> Btw, I hope it's okay to use inline styling the way I did, where I did, per
> the wiki Grandmaster rules: I find it tends to often work better than the
> quote quote quote approach to bold.
>
> Jan C.
>
> -----Original Message-----
> From: wp-docs-bounces at lists.automattic.com
> [mailto:wp-docs-bounces at lists.automattic.com] On Behalf Of Jane Wells
> Sent: Sunday, November 27, 2011 9:50 PM
> To: wp-docs at lists.automattic.com
> Subject: [wp-docs] plugins page could use a touch-up
>
> http://codex.wordpress.org/Managing_Plugins
>
> Is still focused on manual uploading and updating of plugins, should give
> equal time and prioritize within-dashboard installation and updating since
> it's more common now.
>
> Would also be good to have a bit under troubleshooting that suggests
> turning
> off all plugins and re-activating one at a time to see which one is causing
> the break.
> j
> _______________________________________________
> wp-docs mailing list
> wp-docs at lists.automattic.com
> http://lists.automattic.com/mailman/listinfo/wp-docs
>
> _______________________________________________
> wp-docs mailing list
> wp-docs at lists.automattic.com
> http://lists.automattic.com/mailman/listinfo/wp-docs
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.automattic.com/pipermail/wp-docs/attachments/20111201/8a88bfe8/attachment.htm>


More information about the wp-docs mailing list