For discussion around building a module which could provide "bird's eye" documentation of a website.
Note: The module has now been coded: http://drupal.org/project/sitedoc - thanks, NancyW!
Any further discussion should be moved to its issue queue: http://drupal.org/project/issues/sitedoc
This group is now closed.
Site Documentation module released!
Nancy Wichmann has single-handedly coded up the Site Documentation module! Here's a screen shot of it in action (click for a larger version):
Send your improvements to the issue queue. Thanks, Nancy!!
Read moreBrainstorming: What is useful to have documented?
Let's start with brainstorming a list of things that would be useful to have documented when you inherit a new site. Here are a few I can think of off the top of my head:
- List of enabled modules
- What roles exist
- Permission assignments (though making this look readable is going to be a fun task ;))
- What content types (and their fields) exist
- What vocabularies exist, and what content types are they assigned to
- What forums exist
- Workflow module permissions
- System variables (?)
- Other?
Feel free to respond here with your own ideas!
Read moreRFC: Site documentation module proposal
Copy/paste from devel list:
When inheriting a site from a client and trying to figure it out, there are a number of things one normally does...
- Go to the content types listing and take a look at what types exist, and what the field definitions are for those types.
- Check out what roles there are, and what permissions are assigned to those roles.
- Check out what taxonomy vocabularies exist, and to which content types they're assigned
- etc.
This is all rather time-consuming, as it requires going to about 50 admin screens, and it's difficult to get a "big picture" of what's happening.
Having been asked to write a document containing some of these things on a site, I'm thinking of writing a module that basically nicely formats a db dump into an HTML page so you can get a bird's eye view of what the site entails.
Read more