Posted by bonobo on July 17, 2007 at 6:35am
Jump to:
| Project: | DrupalEd |
| Component: | Documentation |
| Category: | feature request |
| Priority: | normal |
| Assigned: | Unassigned |
| Status: | active |
Issue Summary
Use this issue to identify areas that need documentation. Ideally, two things will begin to happen:
1. People will create individual issues for specific areas needing documentation; and
2. In the issue queue, people will contribute documentation (in the form of uploaded files, or in the issue threads) that can be incorporated into the install profile.
Comments
#1
Drupal comes with a Help API, and each module can include a help page for administrators. Drupal also provides online handbook documentation for many tasks (although it is very disorganized).
DrupalEd comes with a number of Wiki pages that are introductory documentation. It also has a readme.txt file. Much of this content would probably be deleted or hidden from public view in a real world application.
The Drupal Book module allows easy creation (and hiding) of an entire document structure.
There is also a module called HelpTip which can provide context sensitive blocks intended for well ... help tips. An advantage of the HelpTip module is the ability to move the location of the displayed context sensitive help, or hide it completely, like any other block.
I mention all these documentation options because they are available to us, and I could not find an official DrupalEd policy on how documentation is to be included in the project.
What are your thoughts? Where should documentation go? What are our target audiences for documentation (admins, users)?