[drupal-docs] Admin help longs to be read by skilled Drupal user

Steven Peck speck at blkmtn.org
Sat May 28 18:22:21 UTC 2005


Technical vocabulary
http://en.wikipedia.org/wiki/Controlled_vocabulary
 
Techy is ok when writing documentation about a technical subject.  It is, in fact, critical so that people can understand what specifically you are writing about.  If someone doesn't know what a word means and intent to continue working with a technical endeavor (pro quality website CMS) then they need to look the word up so that they can communicate effectively and accuratly with others.
 
As to the comments, then if the discussions are long over or the additoinal content of the discussion ahs been addressed by updates to that discussion, then it is time to remove them.
 
-sp

________________________________

From: drupal-docs-bounces at drupal.org on behalf of Anisa
Sent: Sat 5/28/2005 7:13 AM
To: drupal-docs at drupal.org
Subject: Re: [drupal-docs] Admin help longs to be read by skilled Drupal user


Some of it is a little techy...  Is that OK?  (ex. RSS, OPML in aggregator).

I long to delete some of these old comments...

Anisa.

Kieran Lal wrote:


	Howdy, 203 of you completed the Drupal documentation survey and told  
	us that the number one thing you wanted was module documentation.
	
	The goal of this admin help documentation is:
	1) Provide documentation for Drupal modules.
	2) Improve the usability of the admin help.
	3) Improve the documentation teams ability to work with admin help by  
	single sourcing it from the documentation handbook.
	
	Here is the documentation for Drupal core:http://drupal.org/handbook/ 
	modules
	Here is the documentation for some of Drupal contributions: http:// 
	drupal.org/handbook/modules/contributions
	
	The handbook module pages start with executive summaries that are  
	also admin help.  Pretty clever, don't you think.  The handbooks are  
	currently under development, stay tuned for more improvements.  It  
	would be greatly appreciated if knowledgeable Drupal users could read  
	some of them and report back on where they are wrong.
	
	If you need a site to confirm this documentation, create an account  
	on: http://demo.civicspacelabs.org/home and send me a link to your  
	profile.  I'll make sure you get the access you need to confirm the  
	documentation is accurate.
	
	Thanks for you help,
	Kieran
	
	  

-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/ms-tnef
Size: 5233 bytes
Desc: not available
Url : http://drupal3.drupal.org/pipermail/documentation/attachments/20050528/b743f6b0/attachment.bin


More information about the drupal-docs mailing list