I recently got the opportunity to work on an idea that I've had for a few weeks – some kind of automized technical documentation of Drupal sites. It resulted in a rudimentary but working module Documentation Robot, collecting some technical information about the site where it is installed and summarizing it on a page.
It currently collects information about node types (including CCK fields), installed modules/projects, and user roles. In the pipe is also support for documenting views, panels, better CCK field documentation, and a tonne of other ideas I got. I also want to make the collected information re-usable in a number of different formats (for example DITA or creation of book nodes), but that is further off in the future.
Now, I know that this group is about documentation at drupal.org – so I'm sorry for posting off-topic. But I know there are lots of skilled and knowing documenters here, and I would like to ask for feedback before spending many more hours on this project (and hopefully making it a project at drupal.org).
- Have you seen similar projects before, that could use some help instead of me running off with a separate project?
- Would you find this kind of automated documentation useful?
If you have any other ideas or comments I am of course happy.
Below is a screenshot of the Documentation Robot installed on a site I was using for a completely other purpose. The page was made without any extra configuration – it just reads off the settings on the site.
Cheers,
//Johan Falk, NodeOne, Sweden
PS: If you're interested in more details, check out the module's README or just pop me an e-mail.
| Attachment | Size |
|---|---|
| docrobot-example.png | 136.86 KB |
| docrobot.tar_.gz_.txt | 3.33 KB |