End-User Documentation Questions
Hi,
RB comes with a lot of good documentation. However, we're going to need to
write application specific documentation on using the report designer for
the
end-users of our product.
First, is there a list of all the documentation about the product? I've
found a
lot of neat documents on the site, which aren't included in the installation
directory.
Second, what is the licensing restrictions on the documentation? We'd rather
not distribute the documenation "as is" since most seems to blur the line
between Delphi and the end-user -- plus I'd rather not have Digital
Metaphor's contact info, examples don't match our app, certain
features aren't available, etc. i.e. Can we copy a lot of the "reference"
type
materials into our manuals rather than just trying to paraphrase the
same things throughout much of our docs.
Third, is there a good RAP end-user reference? RAP seems to rely so
heavily on Delphi knowledge that we are worried about it for end-users.
Thanks,
Brett
RB comes with a lot of good documentation. However, we're going to need to
write application specific documentation on using the report designer for
the
end-users of our product.
First, is there a list of all the documentation about the product? I've
found a
lot of neat documents on the site, which aren't included in the installation
directory.
Second, what is the licensing restrictions on the documentation? We'd rather
not distribute the documenation "as is" since most seems to blur the line
between Delphi and the end-user -- plus I'd rather not have Digital
Metaphor's contact info, examples don't match our app, certain
features aren't available, etc. i.e. Can we copy a lot of the "reference"
type
materials into our manuals rather than just trying to paraphrase the
same things throughout much of our docs.
Third, is there a good RAP end-user reference? RAP seems to rely so
heavily on Delphi knowledge that we are worried about it for end-users.
Thanks,
Brett
This discussion has been closed.
Comments
1. Learning ReportBuilder is a tutorial system designed for end-users. (see
article below) .
2. You may use materials from the Developers Guide and RBuilder.hlp as well.
Please include a copy right. You can contact info@digital-metaphors.com if
you would like to receive the Frame Maker source files to the Developers
Guide and Learning ReportBuilder Guide.
3. There currentlyis not an end-user RAP reference. We hope to have
something to offer in the future.
--------------------------------
Article: Learning ReportBuilder
--------------------------------
Learning ReportBuilder is a complete learning system designed to teach end
users how to build a range of reports. This system includes a 125-page PDF
file, a stand-alone application complete with a database, and a help file.
The PDF file is comprised of a series of tutorials that step end users
through the process of building reports as simple as a table listing and as
complex as crosstabs. The tutorials also introduce conceptual aspects of
report building along the way. The application is used in conjunction with
the tutorials so that the learning experience is interactive. The end user
just prints out the PDF file, runs the application, and learns
ReportBuilder. The help file is accessible from the application, so all
three tools work together to provide a seamless learning environment.
Learning ReportBuilder installs into C:\Program Files\LearnReportBuilder.
When the system has successfully installed, a complete set of instructions
appears in the form of a 'ReadMe' doc, so the end user knows just what to do
upon installation.
The documentation requires Adobe Acrobat Reader, which is also available for
download.
Learning ReportBuilder download page:
http://www.digital-metaphors.com/Subpages/Downloads/documentationLRB.html
--
Nard Moseley
Digital Metaphors Corporation
www.digital-metaphors.com
Best regards,
Nard Moseley
Digital Metaphors
www.digital-metaphors.com
(see
A bit much. We'll include samples in our app but a lot of the areas of the
tutorial end-users would never and can't see. Examples not specific to our
app are just more likely to confuse them.
well.
You just made a lot of friends in our documentation team! They should
be able to cut-and-paste from the PDF/help files the "reference" material.
Examples need to be rewritten anyway.
Ugg. That is definitely the most complex part of it. Some sort of RAP syntax
reference would be useful, object/properties list would be nice -- but at
least
that is displayed.
BTW. Any plans for a Basic-like syntax option for RAP? Pascal is fine for
our developers, but it is definitely an issue for end-users creating
reports.
Thanks,
Brett
Thanks for the feedback.
No immediate plans to implement a basic like syntax, but that would be a
great enhancement.
--
Nard Moseley
Digital Metaphors Corporation
www.digital-metaphors.com
Best regards,
Nard Moseley
Digital Metaphors
www.digital-metaphors.com