:: Forum >>

Top 10 items missing from the documentation

The suggestion to ask for a "Top 10" of most pressing documentation requirements sounds very reasonable. So here is the question:

- what are the most important topics missing from the current documentation?
Alex (ActiveWidgets)
Thursday, June 9, 2005
I'd like to see a more detailed overview of how the framework has been built. I see snippets here and there in the forums but nothing truly cohesive. The 3 unfinished links (see: http://www.activewidgets.com/general.doc/) would be a nice start:

- Linking html to data with controls
- Customizing control appearance with templates
- Connecting to the external data sources

What about a section on "Best Practices" -- I see places where code has been improved on by others. These could serve as the examples.

All documentation should have clear, yet simple examples.

I know how time consuming this is, so here's another idea:
You come up with a list of sections that need to be written, then invite others to contribute help text for that section. You decide which one should be used as the official text, then perhaps reward that person with an Amazon book token and their name on the web site for all time? It sounds corny, but it might just work!
Steve N
Thursday, June 9, 2005
Oh... and off course a "known bugs / issues" section would be good too.
Steve N
Thursday, June 9, 2005
Another comment...

Alex, I'm using the AW framework to build new widgets. I see that the grid.js source is well commented, but what I would like to see are more comments in the underlying core source code. For example, what is the 'proxy' prototype? How is it used and when? I'd like to see some more detail in gecko.js too.

I think you're doing a great job. I haven't seen any better MVC implemention for ECMAScript yet, and I'd like to make the recommendation to my company that we use your toolkit. The documentation aspect is the big red flag though I'm sorry to say.

Still, let's move forward :)
Steve N
Friday, June 10, 2005
Any more suggestions for documentation anyone?
Steve N
Monday, June 13, 2005
Tuesday, June 21, 2005
A section on creating your own templates I think would be good.
David D
Wednesday, June 22, 2005

This topic is archived.

Back to support forum

Forum search