My WP Help plugin just got a huge update. Version 1.0 is really worth checking out. I’m quite proud of it.
WP Help is a plugin for creating documentation for display within the WordPress admin. Many WordPress installs are customized, and it’s really helpful to have a centralized resource for documenting those features. You can create documents about creating content, editing content, moderating comments, or whatever you want! If you have clients who can’t seem to remember how to do X, you should install WP Help and document it for them. WP Help is powered by WordPress Custom Post Types, so you create content using the full WordPress editor.
Oh yeah. This is the feature you’ve all been waiting for. If you have a standard set of help documents you want to use on multiple sites, this lets you do that. Create the documents, grab the (secret) sync URL for that site, and then plug that URL in to other sites. Those other sites will automatically pull down those documents, and keep them up-to-date (even handling new documents, deleted documents, renamed documents, and re-parented documents). Any internal links in the original document will be rewritten to be local to the destination WP Help install. So go ahead and use the WP internal linking functionality on your source site and know that those links will work on all the destination sites!
The menu item for the help documents can now be placed in one of four locations:
- As a Dashboard submenu
- Top level, above the Dashboard
- Top level, below the Dashboard
- Top level, at the bottom
You get a live preview of this (yeah, I know, super fancy).
The menu name (and page title) can be changed. Just doubleclick the page title, edit it, and hit return. Boom. Again, this has a live preview.
Topics List Name
Likewise the topics list header can be renamed. Doubleclick, edit, return. Live preview.
Edit Links & Management Links
If you can edit help documents, you’ll get an edit link. When editing, there is a handy “Manage” link to jump you back to the documents management interface. Navigating in general has been improved quite a bit.
There is now a simple dashboard widget, listing all of your help documents.
Better Default Access
A lot of you said that you have Contributor-level users who need documentation just like authors do. So now they can view documentation by default (there’s a hook if you want to change the capability required to view help documents).
Lots of Little Tweaks
There are numerous little tweaks to improve your experience. Check out out!
Things I’m considering:
- Restricting individual documents to users with a certain level of access
- Multiple sync sources
Any other ideas?