Description
Site developers and operators can easily create help documentation and notices for the admin area. Include a help section with pages of instructions, or add a help box just about anywhere on the back-end (see site locations and page locations below).
- Supports custom post types
- Supports Gutenberg and Classic editors
- Completely customizeable – colors, admin menu name, icon, logo, etc
- Change the admin footer text to admin contact information or whatever you want
- Easily import settings from another site
- Import or auto-feed documents from another site
- Users can reset meta box and admin list column preferences from profile page
- Use it for notices and reminders, too!
Site Locations
- Main documentation page
- Admin bar
- Dashboard
- Post/page edit screen
- Post/page admin list screen
- All other pages that are listed on admin menu
Page Locations
- Contextual help (even on Gutenberg)
- Top
- Bottom
- Side
Demo
Screenshots
Main documentation page 
Add a doc to the top of any page as a notification 
Bottom page placement 
Classic contextual help and side meta box 
Gutenberg contextual help and side meta box 
Dashboard meta box with custom colors 
Manage the help docs like any other post 
Import documents from another site 
Settings page 
Settings page with colors changed
Installation
- Install the plugin from your website’s plugin directory, or upload the plugin to your plugins folder.
- Activate it.
- Go to Help Docs in your admin menu.
FAQ
-
Who can add a help section?
-
Anyone that has the Administrator role, or other roles that you specify.
-
Can I use the same documentation across multiple sites?
-
Yes, you can choose to automatically feed documents or import them locally from a remote site with the same plugin.
-
Where can I request features and get further support?
-
Join my WordPress Support Discord server
Reviews
September 20, 2023
Great plugin to create internal admin panel documentation. Perfect for agencies
May 8, 2023
Since the fantastic Simple Documentation by Mathieu Hays hasn't been maintained in 2 years, this plugin has stepped in to take up the slack. It's simple but powerful for adding developer documentation to multiple sites easily.
It allows you to add documentation to specific pages (including custom post type pages) as well as maintain a central documentation list for the client.
Highly recommended for developers to use.
February 7, 2023
The best plugin for documentation. Highly recommended if you want to add help boxes on pages for admins that don't know what they are doing. Also having a dedicated help section with instructions is very useful. Very cool that I get to change the name and colors, too! I am able to eliminate a lot of repetitive questions. I can also use it for notices when I need to alert my team before they make important changes to the site. And there are no premium options that you don't have access to; it is completely free! Kudos!
Contributors & Developers
“Admin Help Docs” is open source software. The following people have contributed to this plugin.
Contributors
Translate “Admin Help Docs” into your language.
Interested in development?
Browse the code, check out the SVN repository, or subscribe to the development log by RSS.
Changelog
1.1.5
- Fix: PHP warning about id variable not being found on every page load
1.1.4
- Fix: Sorting by order column not in order (props alex_p6577 for pointing this out)
- Fix: Documentation page ordering issue (props alex_p6577 for pointing this out)
- Fix: Attempt to read property “singular_name” on null (props alex_p6577 for pointing this out)
1.1.3
- Update: Added setting to change user capability
- Fix: Editors could view menu link and dashboard widget, but not view docs (props chrismaclean for pointing it out)
1.1.2
- Update: Added setting to disable curly quotes site-wide that make sharing code difficult
- Fix: Resize cursor showing up on doc list items
1.1.1
- Fix: Custom link fields not showing up for some people
1.1.0
- Tweak: Highlighted “Enable This Site” checkbox on imports when disabled
- Update: Added deactivation survey
- Update: Added support for importing custom urls with auto-updating domain
- Update: Added new site location for custom url
1.0.9
- Tweak: Updated Discord support link
1.0.8
- Tweak: Added icons to dashboard TOC
- Tweak: Added ability to add imports/feeds to dashboard TOC
- Fix: Hid “Add to Dashboard TOC” by default
- Fix: Replaced early escapes with sanitizers
1.0.7
- Update: Added dashboard table of contents (props chrismaclean for suggestion)
- Tweak: Updated changelog to use commonly used prefixes (Fix, Tweak, and Update)
1.0.6
- Update: Added optional setting for allowing the addition of missing user meta merge tags to Gravity Forms dropdowns
- Update: Added missing
index.phpto/classes/and/js/folders - Fix: Excerpt meta box title changing on other post types
1.0.5
- Update: Added video to readme
- Tweak: When resetting settings, added a notice instead of attempting to refresh
1.0.4
- Fix: Nested ordered lists on main documentation page not showing proper list types
- Update: Added links to plugins list page
1.0.3
- Fix: Minor fixes
1.0.2
- Update: Added feedback form to About tab
1.0.1
- Initial release on WP.org January 23, 2023
1.0.0
- Created plugin on November 14, 2022