|
PureBytes Links
Trading Reference Links
|
Hi,
As a long-time professional programmer, I strongly agree with Tomasz about clearly stating problems. Nothing is more frustrating to a programmer than trying to fix a poorly-described problem. We must be clear!
Below is a format that I've used and which my test team (at work) likes. Even though it might look like extra effort, you'll probably end up writing twice as much in follow-up, clarifying e-mails if you don't describe it well in the beginning. I'm offering this as a good format for posting something here on the user forum or to AB support.
Comments?
Regards,
Dan..
---- Suggested Bug Format ----
TITLE: (5-10 CONCISE words summarizing the problem. E.g. "GetExtraData does not return EPS".)
DESCRIPTION: (1-2 paragraphs clearly describing what the problem looks like, when it occurs and why it's important. E.g. "Using TeleChart as a data source, I'm trying to....")
EXPECTED RESULTS: (Describe the results you expected. E.g., "I expected GetExtraData to return EPS data from my TeleChart data.")
ACTUAL RESULTS: (Describe the results you ACTUALLY got. E.g., "When GetExtraData was called, it returned the error message, 'XXXXX'.")
STEPS TO REPRODUCE: (Describe the specific steps to reproduce the problem. E.g., "1. Add GetExtraData to AFL code. 2. Click 'Verify Syntax'. 3. Etc.)
-------------- Original message --------------
> Hello,
>
> When contacting support please clearly state what you have problem with
> and ask actual question(s) that you are expecting us to answer to.
>
> While we love receiving informal letters with "general impressions", etc.,
> it helps a lot to actually have a list of questions to be answered.
>
> Please also note that we do not see your computer screen and letters
> in form of one-liners like:
> "It stopped working"
> do not allow us to diagnose the problem.
>
> So please try to describe in detail few steps that you did before problem
> occurred
> and/or (preferably) all steps needed to reproduce problem (if possible).
>
> Best regards,
> Tomasz Janeczko
> amibroker.com
>
>
> ------------------------ Yahoo! Groups Sponsor --------------------~-->
> Put more honey in your pocket. (money matters made easy).
> http://us.click.yahoo.com/r7D80C/dlQLAA/cosFAA/GHeqlB/TM
> --------------------------------------------------------------------~->
>
> Please note that this group is for discussion between users only.
>
> To get support from AmiBroker please send an e-mail directly to
> SUPPORT {at} amibroker.com
>
> For other support material please check also:
> http://www.amibroker.com/support.html
>
>
> Yahoo! Groups Links
>
> <*> To visit your group on the web, go to:
> http://groups.yahoo.com/group/amibroker/
>
> <*> To unsubscribe from this group, send an email to:
> amibroker-unsubscribe@xxxxxxxxxxxxxxx
>
> <*> Your use of Yahoo! Groups is subject to:
> http://docs.yahoo.com/info/terms/
>
>
>
Please note that this group is for discussion between users only.
To get support from AmiBroker please send an e-mail directly to
SUPPORT {at} amibroker.com
For other support material please check also:
http://www.amibroker.com/support.html
YAHOO! GROUPS LINKS
|