[documentation] Barriers to entry...

Nancy Wichmann nan_wich at bellsouth.net
Sat Nov 14 16:46:07 UTC 2009


Lee Hunter wrote:

> We're calling this a "help" system but that's not at all what's being
written. It would be much more accurate to call it a "Module Reference".

> Help system content is normally all about the user

 

I believe we actually need both. And the two forms need to be written for,
and by, different audiences. While I can agree that the current "reference"
is more for developers, the Advanced Help module is better geared for the
user. Unfortunately, it is the developer, who is generally unsuited or
unwilling to do that documentation, who is in the best position to provide
it - or at least the implementation to provide it. For the time being, I
suspect we will have to continue relying on the handbooks for this.

 

It could be useful, however, to encourage those who are better suited for
the handbooks to also work with the developers to develop Advanced Help.
They could provide the text and point to where it is needed; the developer
can then do the relatively simple steps to implement that help.

 

 

Nancy E. Wichmann, PMP 

Injustice anywhere is a threat to justice everywhere. -- Dr. Martin L. King,
Jr.

 

-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.drupal.org/pipermail/documentation/attachments/20091114/a7ad0b41/attachment-0001.html 


More information about the documentation mailing list