To the Lazarus team,

You guys should really decide what you want to use as a help medium.
The wiki OR fpdoc class documentation. I don't use LCL much, so when I
do, I need lots help. Pressing F1 in the IDE takes me to the class
documentation where I would expect to see help. Take the TStringGrid
as an example. There is absolutely NO help in the fpdoc class
documentation, so pressing F1 in the IDE is useless. I had to then
manually search through the wiki (luckily I know about the wiki) to
see if there is any information. Oh by the way, wiki search support is
crap too.

Anyway, lucky for me the wiki contained lots of help on the StringGrid
options etc, but that help should really be in the developers "first
port of call" - the medium that is displayed when I pressed F1.
Currently that is fpdoc class documentation.

I'd suggest you take some time out of developing nice new features in
the IDE, and rather get your house in order. Sort out the damn
documentation mess. I'm pretty sure you guys know how important
documentation is. And currently the little help there is in LCL is
fragmented too - a double whammy! Some docs in fpdoc class files, some
on wiki, some in blogs etc... Learn from Borland's mistakes; a
framework needs documentation, and only one set of pooled
documentation too. I know your resources are spread thin, but that is
more the reason to keep the little available help there is in a single
location and single medium.

If your answer is that the wiki is simply easier to use that fpdoc
editor, then why not create a wiki frontend to the fpdoc class help.
LufDoc (from a guy name Lars) did something similar so it is possible.
That might even double up as a good "sample project for fclweb" or
whatever the web controls are called.

Just my 2c worth...


-- 
Regards,
  - Graeme -


_______________________________________________
fpGUI - a cross-platform Free Pascal GUI toolkit
http://opensoft.homeip.net:8080/fpgui/

--
_______________________________________________
Lazarus mailing list
[email protected]
http://lists.lazarus.freepascal.org/mailman/listinfo/lazarus

Reply via email to