bug-recutils
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [bug-recutils] Work needed in the user manuals


From: Jose E. Marchesi
Subject: Re: [bug-recutils] Work needed in the user manuals
Date: Thu, 09 Aug 2012 20:08:45 +0200
User-agent: Gnus/5.13 (Gnus v5.13) Emacs/24.0.92 (gnu/linux)

Hi John.
    
    2. I couldn't find the word "escalar" in any English dictionary.  Should
       this read "scalar" or is it some specialist terminology which is supposed
       to be familiar to the readership?

That is indeed a typo.  I just pushed a patch fixing this.
    
    4. I recommend that all the chapters whose names begin with %  be retitled, 
       to something more descriptive.
    
    5. Like you say, the chapters descibing the tools are very terse and read 
like a 
       reference rather than a tutorial.   I recommend that these chapters be 
       made into an appendix, and in their place three or four new tutorial 
type 
       chapters:
    
       "Retrieving your data" - covering the use of recinf, recsel and recfmt
       "Entering data" -- covering recins
       "Editing entries" -- covering recset and recdel (maybe recfix too)
       "Importing and Exporting" -- all the rec2* utilities.

That looks like a nice partitioning of the topics.  Would you like to
help writing some of the contents?  I have some development work to do
before 1.6, so if the manual could be improved in the meanwhile it would
be great.
    
    6. There is no index.  The manual is big enough that it could use
    one.

Yes, definitely.

-- 
Jose E. Marchesi         http://www.jemarch.net
GNU Project              http://www.gnu.org



reply via email to

[Prev in Thread] Current Thread [Next in Thread]