Hartti Suomela's Forum Nokia Blog
Known issues - have you noticed the improvement?
hartti | 19 December, 2006 04:30
In early September I wrote about tackling the known issue documentation. If someone does not remember, the known issue notes and solution documents can be found in the Forum Nokia Technical Library.
Since then there has been a number of conference calls (twice a month - I have not attended all, though) going through one known issue after another known issue. Before the meetings I have spent numerous hours writing myself a number of these documents using discussion boards, internal error databases, and firmware release notes as source material. I have also spent time testing the specific behavior on a number of devices.
Of course, in the process we have found a number of serious issues (like the one about post-dial DTMF tones, mentioned in the blog post linked above), which is a humbling experience. I hope that providing more accurate information about the intricacies of Nokia's devices, you developers have easier time to create successful applications.
During the second half of this year, in my opinion, we have made a good progress on making this part of the documentation offering more complete and more helpful to the developer. But that's only my view. Do you have any feedback or opinions to us on how we have fared?
General |
Next | 
Previous |
Comments (6) | 
Trackbacks (0)
Comments
Re: Known issues - have you noticed the improvement?
hartti | 20/12/2006, 18:21
Wow Marcus! Thanks for the excellent suggestions! I'll check if we could implement these and how soon.Hartti
Re: Known issues - have you noticed the improvement?
matrix241 | 21/12/2006, 20:42
What about grouping the issues also by argument ?
For example :
java issues :
networking...
graphics....
fileconnection...
What about documents about real implementations details not given in javadocs, not only issues?
Best Regards
Re: Known issues - have you noticed the improvement?
hartti | 22/12/2006, 03:02
"What about grouping the issues also by argument ? "There is already the Java / Symbian level grouping so I thjnk you are after more granular groupings, right?
We'll have to investigate this too. This should not be impossible, but cannot say for sure right now.
"What about documents about real implementations details not given in javadocs, not only issues?"
This might lead to confusion as there would be separate Javadocs for each implementation. In general (when talking about JSRs)I see Javadocs as specification level documentation, not implementation level documentation.
Hartti
Re: Known issues - have you noticed the improvement?
hartti | 22/12/2006, 02:58
"- Having a page with issues sorted by last-changed date and the summary text, linking directly to the actual contents "I think something like this will be in the next release
"- Make 20 most recently changed topics available as an RSS feed "
This is not feasible right now because of some changes happening under the hood. but maybe later.
"- And my favourite - the most difficult one: finding a way of continously merging the Known Issues with the corresponding reference sections in an online version of the SDK docs, so that the behaviour in the docs actually reflects the true implementation on the devices."
We'll investigate how this could be implemented. Please be patient.
Hartti
Re: Known issues - have you noticed the improvement?
hartti | 19/01/2007, 03:02
Following Marcus' suggestions in this thread, I am happy to tell you that the FN Technical Library's Change history now contains links directly to the updated/added issues.http://www.forum.nokia.com/library
and
http://www.forum.nokia.com/document/Forum_Nokia_Technical_Library_v1_35/contents/FNTL/Change_history.htm
Great suggestion Marcus! Keep'em coming!
Re: Known issues - have you noticed the improvement?
mgroeber9110 | 20/12/2006, 11:18
One thing I still find a bit difficult is getting to know about relevant issues - other than by regularly polling the document, looking at the "change history" section, and then typing the KIS... numbers one-by-one into the search box, and trying to remember them for the future when I might need them.
Possible options could be:
- Having a page with issues sorted by last-changed date and the summary text, linking directly to the actual contents
- Consistently using the "new topic" label in Robo Help (I think that's the tool that is being used, from the looks of it) to add the little red sparkle to new/changed documents. This has occasionally appeared in previous versions, but is for example missing from this week's update.
- Make 20 most recently changed topics available as an RSS feed
- And my favourite - the most difficult one: finding a way of continously merging the Known Issues with the corresponding reference sections in an online version of the SDK docs, so that the behaviour in the docs actually reflects the true implementation on the devices.