Am Montag, den 30.10.2006, 15:20 +0000 schrieb Dennis Byrne:
> Sounds like an opportunity for you to contribute something to the open source 
> community.

You're right, and I am thinking about it, but my time is also sparse.
Perhaps ill have some time in 2007.

Two additional notes before assigning all the documentation tasks to a
newbie like me ;-)

1) Writing docs is not a one-time task but a kind of project-culture.

2) Docs should be written by the developers. I could delve in to the
code, but I would need two hours to understand and document a thing,
while the developer would need ten minutes.

When I develop something myself, in the beginning im hacking just to get
things work. But before I publish/commit anything (even to two/three
collegues), I polish everything up.


When thinking about how I could/would contribute, I had two thoughts:

1) Looking at other "high quality" UI-projects (eg. SWT or Swing) how do
they document their stuff?

2) For users of the framework, I imagine a wikipage for each
ui-component consisting of a fixed set of sections (usage, examples,
tags, one sec. for each known renderer etc, link to the examples on
irian etc.)

E.g. if I would want to use tree2, I had one page documenting everything
important. And by the way on would link everything wiki-like to other
components/events etc


Perhaps one could encourage active subscribers of [EMAIL PROTECTED] to write
their "insights" in some structured form into the wiki!?

Regards, Sebastian.

  • Re: javadoc Arash Rajaeeyan
    • Re: javadoc Sebastian Menge

Reply via email to