develooper Front page | perl.perl5.porters | Postings from December 2003

Re: Poor State of the Man Pages

From:
david nicol
Date:
December 1, 2003 15:39
Subject:
Re: Poor State of the Man Pages
Message ID:
1070321924.978.24.camel@plaza.davidnicol.com

Do we have a glossary? It is common for reference works to
have glossaries.  It is curious that I find myself referring to
ESR's "Jargon pages" rather than a closer reference for perl jargon.

http://catb.org/~esr/jargon/html/go01.html

does not list "transliterate" and tr(1) claims to be short
for "translate."



> But when do you stop? If the goal is to write documentation in English
> for people who don't master English, when do you stop explaining?
> Until you have no multi-syllable words left? Until the documentation is
> 70% dictionary and 30% technical? Until Dr. Suess approves it?
> 
> Don't dumb down the documentation. It'll lose value.
> 
> 
> Abigail



-- 
david nicol "I'll be working, working; but if you come visit I'll
put down what I'm doing: my friends are important" -- David Byrne

nntp.perl.org: Perl Programming lists via nntp and http.
Comments to Ask Bjørn Hansen at ask@perl.org | Group listing | About