MessageDocs

Drupal tells you what is going on in your site through the message system. Messages however are often very cryptic and site specific and can even for experts require research.

“If you are an experienced Drupal user you have numerous times copied a Drupal message, pasted it in google, removed the site specific part of the path, hit enter and scanned the search results for blog posts or issue queue comments that contain your message string.“

With MessageDocs you’ll never have to do that again: the MessageDocs module will turn Drupal messages that appear on your site into documentation links. When installed on your site, a user that clicks a link will visit a newly created message report on the messagedocumentation server. By default this is configured to be messagedocs.com, but you could set up your own message documentation server if you so wish to. On the report page the user will find wiki articles that are related to the message they clicked on. If somebody had already reported a given message they will instead be directed to the existing report, where they could see any comments you or other users added to the report.

On MessageDocs.com it's also possible to register a site. Once registered, you will receive email notifications whenever a new message is created on your site. As and admin you can also see an overview of the reports that were created for your site, comment on the reports or write a wiki post about the messages and so show your users that you are aware of reported problems.

MessageDocs is a module that was created by Pronovix, as part of our effort to bring structured (DITA based) documentation to Drupal read more about our documentation efforts on our blog.

Downloads