gettingstarted
[Top] [All Lists]

Re: Documentation Errors/The RB "Neverending Story"

To: gettingstarted at lists dot realsoftware dot com
Subject: Re: Documentation Errors/The RB "Neverending Story"
From: Emile Schwarz <Emile dot A dot Schwarz at wanadoo dot fr>
Date: Sun, 30 May 2004 09:58:26 +0200
Delivered-to: gettingstarted at lists dot realsoftware dot com
List-help: <mailto:gettingstarted-request@lists.realsoftware.com?subject=help>
List-id: Getting Started <gettingstarted.lists.realsoftware.com>
List-post: <mailto:gettingstarted@lists.realsoftware.com>
References: <20040529170010 dot B71C91F633F at lists dot realsoftware dot com>
Hi all,

I am sorry, because I think that Terry is right here.

I have a proposal here: instead of putting “About” or “Read-Me” files here and there, put all of these in a pdf file (styled using Language Reference template), add a valid "doc_bug-request at realbasic dot com" email address et voilà.

Pros:
-----
a. Even if you will have few doc reports (both bug or requests), you have the basics of the "What’s new in REALbasic 6" update pdf (for those of us who upgrade from 5.5 to 6).

b. New buyers will get a brand new documentation.

c. Some questions will no more ends in the list because the answers are in the "What’s new in REALbasic 6" update pdf.



On the cons side, there is none (the documentation have to be written, you already have an eMail address to get doc bugs, and the list will still have weird/useless questions here or there and even from me sometimes...)

HTH,

Emile

gettingstarted-request at lists dot realsoftware dot com wrote:
Subject: Documentation Errors/The RB "Neverending Story"
From: Terry Ford <tmford at shaw dot ca>
Date: Sat, 29 May 2004 07:39:57 -0700

Dear REAL Software,

One of the biggest gripes I have had with REALbasic documentation is that the final releases often contain out of date or incorrect information. I have noticed this since my first upgrade to Version 3 from 2.1.

I don't know how many times I have read, "Unfortunately that section of the online reference is out of date and needs to be updated" or "Please report it as a bug against documentation". I've lost track as I don't have enough fingers and toes.

BTW, there should be "Documentation Error" as one of the pop-up selections at the start of a report along with "Feature Request" and "Bug Report".

I understand that Alphas and Betas should be exempt, but more of an effort to update online docs in fc's would allow errors to be reported before the PDF and Printed versions are created. That is, if that's not already too late. In that case, it should be done in the Betas.

To me, Correct Documentation is the 'life blood' of any major Application. This has probably cost RS a lot of new users upgrading after finding that the examples or properties/events/methods in the User's Guide or Language Reference do not work properly. People who subscribe to the lists do get the benefit of these corrections but, as far as I can tell, the vast majority do *not* subscribe to the lists.

I am, personally, so used to this problem that I have learned to live with it.

Also, is there some way that one can subscribe to both the full lists and their Digests; perhaps under a different name or email address? I would like to compare them and decide if I want to go to Digest mode without losing any valuable messages.



_______________________________________________
Unsubscribe or switch delivery mode:
<http://support.realsoftware.com/listmanager/>

Search the archives of this list here:
<http://support.realsoftware.com/listarchives/lists.html>

<Prev in Thread] Current Thread [Next in Thread>