WordPress is a perfect platform on which to build a documentation website. Moreover there are many plugin and theme developers who need to provide documentation for their products. Here are some plugins and themes that make things easier.
Site operators can create detailed, hierarchical documentation for the site’s authors, editors, and contributors, viewable in the WordPress admin.
Powered by Custom Post Types, you get all the power of WordPress to create, edit, and arrange your documentation. Perfect for customized client sites. Never send another “here’s how to use your site” e-mail again.
A powerful yet user friendly plugin that automatically creates a context specific index or table of contents (TOC) for long pages (and custom post types). More than just a table of contents plugin, this plugin can also output a sitemap listing pages and/or categories across your entire site.
Built from the ground up and with Wikipedia in mind, the table of contents by default appears before the first heading on a page. This allows the author to insert lead-in content that may summarise or introduce the rest of the page. It also uses a unique numbering scheme that doesn’t get lost through CSS differences across themes.
Order your pages, hierarchical custom post types, or custom post types with “page-attributes” with simple drag and drop right from the built in page list.
Simply drag and drop the page into the desired position. It’s that simple. No new admin menus pages, no clunky, bolted on user interfaces. Just drag and drop on the page or post-type screen.
The plug-in is “capabilities aware” – only users with the ability to edit others’ pages (editors and administrators) will be able to reorder content.
Adds a CMS-like tree overview of all your pages and custom posts to WordPress – much like the view often found in a page-focused CMS. Within this tree you can edit pages, view pages, add pages, search pages, and drag and drop pages to rearrange the order.
CMS Tree Page View is a good alternative to plugins such as pageMash, WordPress Page Tree and My Page Order. Page management in WordPress won’t get any easier than this!
This plugin helps webmasters/developers to provide documentation through the WordPress dashboard. As an administrator, you can add, edit or remove content, choose the number of items displayed per page in the widget, the targeted backend user role and customize the widget title and welcome message.
This plugins allows you to share 4 types of content: “Link” – a simple link with a custom title and url which will open in a new tab; “Video” – allows you to put an embed code from websites like Youtube, Vimeo, ScreenR (all the ones which gives you iframe based code); “Quick Note” – a short text which intend to help by giving a short tip; “File” – upload a file to the WordPress installation and display the link.
This plugin makes it easy to create a wiki like TOC (table of contents) in your posts or pages using shortcode, no linking or creating anchor is needed.
Creates a post type for “documentation”. It meant primarily for product documentation, though you could adapt if for your own specific use.
- Registers a “documentation” post type
- Registers a “documentation-category” taxonomy
- Registers a “documentation-tag” taxonomy
- Registers a “product-tag” taxonomy
- Adds the post count to the admin dashboard
- Translation ready
Totally free and available on GitHub.
If you are looking for a WordPress plugin to create product documentation, Documentor is the answer. It comes with premium features such as User Feedback form for each tutorial, single page layout with Ajax loading, Drag and Drop reorder or documents, powerful admin panel with live preview of the documentation.
It is WPML and mqTranslate ready so can be used on multilingual sites too. Quality features, premium designs (It comes with 4 skins) and amazing support makes it the best documentation plugin for WordPress users.
weDocs is a clean documentation theme for WordPress that is totally free from weDevs.
You can try out the demo for weDocs here.
This theme is targeted at a very niche audience — the people who have to write documentation for products. This WordPress theme streamlines the process and makes the task of writing documentation a little less painful.
View the live demo to get a feel for what the theme is capable of.
Docs is a documentation WordPress theme aimed at creating online documentation for your product or service, fast. It is powerful yet simple to set up and administer.
Finally, here’s an excellent article about writing good documentation, which I highly recommend reading.
Do you know of any other useful plugins for building documentation centric websites? Let us know in the comments section below.
If you enjoyed this post, make sure to subscribe to WP Mayor’s RSS feed.
UPDATE: This post was updated in August 2015.