Print Page | Close Window

Suggestion: Hire someone to re-do the help file

Printed From: Codejock Forums
Category: Codejock Products
Forum Name: Controls
Forum Description: Topics Related to Codejock Controls
URL: http://forum.codejock.com/forum_posts.asp?TID=10159
Printed Date: 25 April 2024 at 6:36pm
Software Version: Web Wiz Forums 12.04 - http://www.webwizforums.com


Topic: Suggestion: Hire someone to re-do the help file
Posted By: Zookeeper
Subject: Suggestion: Hire someone to re-do the help file
Date Posted: 09 April 2008 at 9:44am
The help file appears to have been a minimal effort.  Example: I wanted to know what types of picture files are valid for a Pushbutton's Picture property.  Here's what the help file has to say about the Picture property:

Description
Gets or sets a graphic to be displayed in a push button.

Property type
Read-write property

Syntax (Visual Basic)
Public Property Picture() As Picture

OK, how useful is that?  It merely states the obvious.  It doesn't tell me which picture formats and resolutions are valid.  The syntax example tells us nothing of use.  It's as though someone stubbed the entry meaning to come back and give it some meat but never did.  That's just one example.  The above entry is typical of most of the property entries in the help file.   Sorry to be a complainer but every entry on a control or its property should tell everything a developer might need to know about it.  They should have remarks and give code examples.   I know that documentation is the last thing we like to do as developers but for a professional product (especially a control library other developers will be using) it is a must and can't just be a half-effort.




Replies:
Posted By: ijwelch
Date Posted: 09 April 2008 at 8:12pm
If the help file gets reworked please can you also split so each product gets its' own help file.
The problem with the current help file is that search results are largely useless as all items location is 'Xtreme Suite ActiveX Controls', i.e. not different for each product.


Posted By: corpcon
Date Posted: 10 April 2008 at 9:13pm
"User-friendly", the manual is not.
 
We've all seen what happens when a programmer designs a program from HIS perspective and not from the user's perspective. It results in a classic lack of usability.
 
Well, the Codejock manual was clearly designed by a programmer with absolutely no sense of usability, practicality or empathy. They need to hire a tech writer who has a really good sense of usability and how to demonstrate procedures in a practical and useful manner.


Posted By: corpcon
Date Posted: 10 April 2008 at 9:20pm
Oleg said in another post ...
Quote RTFM :) Seriously, too much complains about our Help, but nobody even read it.
The irony of this statement is ...
The reason no one reads it is because it often makes no sense to most people. That's why people complain about it.



Print Page | Close Window

Forum Software by Web Wiz Forums® version 12.04 - http://www.webwizforums.com
Copyright ©2001-2021 Web Wiz Ltd. - https://www.webwiz.net