Per a conversation at the documentation BOF about how we are approaching managing documentation at CSU Monterey Bay, here's a screencast and additional information about our approach. Sorry it's been a week, but after the figurative "Drupal Fever" of last week I had a literal fever that laid me up for a while.
Much of this was kind of round-three for older application QuickGuides 2.0 , which we rewrote based on SF State's even older QuickGuides. These were really only based on documentation for the campus Moodle install; however, and we wanted to encompass documentation across projects and applications for our next iteration housed within a larger project called ITeam.
The way we chose to manage documentation was to explicitly relate topics with projects/services and then build up these topics with steps that then can be annotated within the scope of the topic if additional, ad-hoc, information is required. This is basically a big node-reference graph that looks surprisingly like this:
So, finally,here's a video of what this looks like with captions. If the video is too small I can see about upping it to YouTube, but I like the DotSub caption UI... Please note that ITeam is broader than just documentation, so there's a lot of stuff on the screen sometimes. We are hoping to release the "basket" module to the community soon because I think it has use outside the scope of just technical documentation.
Comments
kevee++
kevee++ - but fix up the link to the video - it didn't work.
Doh! Fixed.
Doh! Fixed.
Another note: if you don't
Another note: if you don't want the subtitles, select "Choose Language" from the language drop-down on the player.
BOF notes previously posted...
Notes from the BOF refrenced above: http://groups.drupal.org/node/63218
Drupal programmer - http://poplarware.com
Drupal author - http://shop.oreilly.com/product/0636920034612.do
Drupal contributor - https://www.drupal.org/u/jhodgdon
Module mentioned in video just added to contrib
You can now download the "Nodereference Basket" module from the project page: http://drupal.org/project/nodereference_basket