perl-docs-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Stas Bekman <s...@stason.org>
Subject Re: Fwd: Re: [PATCH] docs/
Date Sat, 20 Apr 2002 19:04:48 GMT
Bill Moseley wrote:
> At 12:13 AM 04/21/02 +0800, Stas Bekman wrote:
> 
>>Me view is different. The /docs area is for heavy daily use and therefore
>>should be clean of noise. completely if possible. We have enough noise 
>>already with these
>>descriptions of each area. I'd even shorten this one. The titles are 
>>*very* descriptive already. But it's fine to keep as as they are.
>>
>>it looks like /about is the area for newbies. Let's put the
>>"what should I read" there as a separate doc.
> 
> 
> Sounds good to me.  Can there still be tiny link at the top of the docs page:
> 
>  "Overwhelmed?" or "Where do I start?" that links to that page?
> 
> Since Documentation is a main menu item newbies will still go there, so it
> would be nice to offer some help to them.  "Hi, you look lost. Can we help?
>  Want to come to my place?"

sure, a tiny link is fine :)
The /docs/index.html page is already quite heavy, if the descriptions 
aren't good enough (which is quite possible), they need to be improved. 
Still these items on /docs/index.html are still very much a part of 
navigation stuff, not the real documents, so their descriptions should 
be as concise as possible while giving enough information to guide the 
reader to the right page. Once the right page is reached, then there can 
be helluva lot of information.

Think of index.html pages as of directories in your folders, the 
filenames should be descriptive enough to guide the browsers to what 
they mean. I think it's pretty much the same here, but the descriptions 
can be a bit longer.

BTW, if I remember correctly in DOS you could add descriptions to each 
file/directory.

__________________________________________________________________
Stas Bekman            JAm_pH ------> Just Another mod_perl Hacker
http://stason.org/     mod_perl Guide ---> http://perl.apache.org
mailto:stas@stason.org http://use.perl.org http://apacheweek.com
http://modperlbook.org http://apache.org   http://ticketmaster.com



---------------------------------------------------------------------
To unsubscribe, e-mail: docs-dev-unsubscribe@perl.apache.org
For additional commands, e-mail: docs-dev-help@perl.apache.org


Mime
View raw message