Front page | perl.wxperl.users |
Postings from July 2009
From: Robin Cragg
July 31, 2009 02:19
Message ID: 913946F0FC58DA4185354F648F5C0EF6BEF49B@exchange01.solutios.com
I think it's worth considering the audience of any documentation before
you write it.
Someone who is completely new to wxPerl and does not know C++ needs
something like what O'Reilly have for Perl/Tk (whether free or
commercial) to walk them through the basics and get them feeling
confident enough to go out on their own and read the API docs.
In contract, someone who has been using wxPerl longer just needs a
quick-and-easy API reference (or even a cookbook?). The C++ notes are
the ultimate source, and most people using wxPerl long enough don't mind
reading them, but if it were not a problem to some people, it would not
be a criticism raised in the discussions; I suspect most people here
would think twice before learning a Perl toolkit where the entirety of
the docs were for VB users. :-)
For me, I think it's more important to get a nice friendly introduction
to the toolkit full of well documented and explained examples and
pictures that can bring new people into wxPerl. As more and more people
get interested, there will be more momentum to get the API documented
(and more volunteers).
One warning I would have for anyone who wants to start managing the
documentation for wxPerl is that the language is still evolving. If you
look at the Perl Monks tutorials on wxPerl, you'll find several don't
work any more. So with every revision of the source, there will probably
have to be minor revisions to the docs. I only say this as incorrect
docs are far worse than docs in the wrong language.
******* Important Notice *******
Solutios is a limited company registered in England and Wales.
Registered number: 3977874. Registered office: 38 Skyline Court, Grange Yard, London SE1 3AN
Please note that Solutios Limited may monitor email traffic data and also the content of email for the purposes of security and staff training.
This message (and any associated files) is only for the use of the intended recipient and may contain information that is confidential, subject to copyright or constitutes a trade secret. If you think that you may not be the intended recipient, you are hereby notified that any dissemination, copying or distribution of this message, or files associated with this message, is strictly prohibited. If you have received this message in error, please notify us immediately by replying to the message and deleting it from your computer. Any views or opinions presented are solely those of the author and do not necessarily represent those of the company.
Scanned by Solutios MailSafe - The Fast and Effective AntiSpam and AntiVirus Solution - Email email@example.com for your FREE 30 day trial!