PlanetSquires Forums

Support Forums => Other Software and Code => Topic started by: Douglas McDonald on November 10, 2010, 09:15:24 PM

Title: Help file / Manual
Post by: Douglas McDonald on November 10, 2010, 09:15:24 PM
Its the hardest thing for a programmer to do........write documentation. While some of the basics are there the help file is very lacking in substance. There are many FF3 items not even listed in the help. As programmers we assume someone will or should "Know" that but all of us don't . I shouldn't say don't, but we may call it something different or think of it in a different way. MS has 20 different names for the same thing so how to look it up? a problem

Every single FF3 item that can be seen in the FF3 program should have a reference in the help file. Every function should have an example or two. If it is linked to Pb the a reference to the PB manual could be stated.

Please don't get me wrong. I'd rather have new / better code than documentation but at times it does no good to have the new stuff if no one knows how to use it.

As one person writing and maintaining FF3 its next to impossible, I understand. Its just frustrating at times to have to post a question on the forum when the answer should be in the help file.

I've been in your position before and I don't know the answer. There is not enough time to do both software and documentation it seems but they are equal in importance to the end user. Even worse the last person that should test software or write documentation is the programmer.

So, it would help the user and sales if a little bit of time could be set aside for the help file / manual. Please I'm not complaining, this is the WISH LIST section and I wish for better help. I'm getting old and need a reference. I don't remember things like I used to be able to do.

Thank you
Doug

Damm I sound like a crybaby......I do not mean it that way
Title: Re: Help file / Manual
Post by: Paul Squires on November 10, 2010, 10:13:03 PM
:D   I hear you. Documentation is a pain to write. You are right though, a bit more meat in the Help file would certainly be more beneficial.
Title: Re: Help file / Manual
Post by: Martin Francom on December 24, 2010, 05:52:22 AM
Paul,
  A better help/doc file would be much appreciated by me.  I understand how hard it is to find the timeto do this work. 
   Here's an idea:  You are as the editor for a Wiki-FireFly,  You could setup a topics outline and then ask FireFly users to help fill in the topics with code explanations and example code.   Then when its all done we will come over to your place for a big beer bash.  (grin)
Title: Re: Help file / Manual
Post by: Rolf Brandt on December 24, 2010, 08:14:20 AM
I can fully understand Paul - writing documentation is a nuisance and very time consuming.

We should not forget though that besides the help file there is the functions library which has a help text for each function.

...and I like Marty's idea (especially the bee bash.
Title: Re: Help file / Manual
Post by: Paul Squires on December 24, 2010, 10:17:57 AM
I'd love to have you guys over for a big beer bash! Granted, we'd probably have one big jumbled up mess of a wiki if everyone was strung out on our Canadian beer!   :D  :D

Title: Re: Help file / Manual
Post by: Bob Houle on December 25, 2010, 01:12:13 PM
Yah! Beer and hockey... I just hope you've given up on the Bruins and have started watching the Canucks.  :-*

Merry Christmas,
--Bob
Title: Re: Help file / Manual
Post by: Paul Squires on December 25, 2010, 08:31:24 PM
Quote from: Bob Houle on December 25, 2010, 01:12:13 PM
Yah! Beer and hockey... I just hope you've given up on the Bruins and have started watching the Canucks.  :-*

Merry Christmas,
--Bob

ha ha ha ha !!! Haven't given up on the Bruins (yet). Still a long way to go in the season yet. It is nice to see Vancouver doing well for a change. I wonder if the Leafs will ever have a good team ever again????  :D  :D  :D

Title: Re: Help file / Manual
Post by: Bob Houle on December 26, 2010, 12:07:41 PM
I think I just spotted their new uniforms.... (see attachment) :D :D :D :D


Merry Christmas,
--Bob
Title: Re: Help file / Manual
Post by: Paul Squires on December 26, 2010, 12:29:10 PM
:D  :D  :D