Posted by wfx on April 21, 2011 at 8:58pm
What tools/modules do you use for site Documentation? I'm looking at using Book module and the plethora of add-on modules to make it more usable for our site help docs. What we have right now is a mess of unrelated nodes and it's hard to find anything. The site topics will encompass a wide array of software our IT department supports and tutorials and videos to walk new users through various tasks.
What tools do you use?
Do you have all your documentation in 1 book or multiple books? How is your site taxonomy set up? Is it easy to find your docs via Drupal's search? Looking for ideas on how to make documentation more effective and easy to find.
Comments
Help injection was just recommended to me
While at the Drupal4Gov code/docs sprint, the Help Injection module was mentioned as an "inspired" solution for help files, if it would work for you. http://drupal.org/project/helpinject
Here's a quote from the page:
Workflow and Use Cases
Advanced Help Injection and Export addresses four workflows where help texts need to be written:
You want to document a website and the help texts are in flux. Write your texts in a Drupal book, inject the context sensitive help icons throughout the website, and let the Help Inject module provide the end-user the help icons.
You want to document a website and the help texts are finished. Write your texts in a Drupal book, inject the context sensitive help icons throughout the website, and export the module. That module is now the complete documentation for a particular website.
You want to document a module. Write your texts in a Drupal book, inject the context sensitive help icons into the pages and forms that your module supplies, and export the new generated help module. Distribute the new generated help module as a sub module with your module.
You want to document a larger project, such as Drupal core. Write your texts in a Drupal book, inject context sensitive help icons throughout the larger project, and export the new generated help module. Distribute the new generated help module as a module with your larger project.
Best, Marilyn
That's a really cool module,
That's a really cool module, going to check that out this week. "Help Inject" is not the most intuitive name but, hey, I'm glad someone took the time to make the module :)
http://www.webbfx.net/