xml-general mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Matthew Brandabur <matthew.branda...@oracle.com>
Subject Re: Help wanted: more qualified developers
Date Wed, 04 Apr 2001 19:12:45 GMT
Documentation? I don't have time to do that! Can't you see I'm busy?

Just kidding.

I will start researching these projects this weekend. Can't wait to get
started.
-mbb

Donald_Leslie@lotus.com wrote:

> Matthew,
> I have written most of the doc for Xalan-J and Xalan-C++, so I am heavily
> oriented towards those projects, but I am confident ANY and ALL of the XML
> projects would welcome quality doc contributions.
>
> If you have any ideas for enhancing / adding to / rewriting the Xalan-J
> and/or Xalan-C doc (including API doc), please let me know.
>
> One task you (or someone) might find interesting: using FOP to produce PDF
> documentation. I added "printerdoc" targets to our Xalan-J and Xalan-C++
> build.xml files some time ago, but I'm sure theres LOTS of room to enhance
> the build procedures and stylesheets.
>
> Another possibility: setting up an infrastructure for generating Java (cf.,
> Javadox) or C++ API doc in XML.
>
> And how about some more sample apps, sample usage scenarios, tutorials? If
> you are prepared to produce some useful documentation, please jump in. You
> can send any Xalan doc to me, and if you become a regular contributor, we
> can see about getting you commiter status.
>
> -- Don Leslie
>
> Matthew Brandabur <matthew.brandabur@oracle.com> on 03/30/2001 04:56:12 PM
>
> Please respond to general@xml.apache.org
>
> To:   general@xml.apache.org
> cc:    (bcc: Donald Leslie/CAM/Lotus)
>
> Subject:  Re: Help wanted: more qualified developers
>
> Alex, you hit the nail squarely. The problem is not that there are no
> writers who would love to contribute - it's that no mechanism yet exists
> for
> enlisting writers. The subject line of this thread sort of backs me up.
>
> Just as in the proprietary world, the need for dedicated documentation
> resources seems to reveal itself after development and design have already
> got off to a blazing start. I've been lurking on various XML/Apache/Cocoon
> lists, looking for a way to contribute. Of course, the way coders get
> started making a contribution is to start fixing stuff. After a while, the
> group gets to know you, and they realize you have worked with the stuff.
> When it comes time to be elected for something like the XML PMC, there you
> are.
>
> But doc people such as myself, we don't code for a living - we document
> APIs, write information plans, re-write specs.
>
> And we like it...
>
> Alex Amies wrote:
>
> > Documentation seems to be one key.  On the other hand there are
> > probably many people out there who would like to write
> > documentation if it is clear that there is a need for particular
> > documentation and that there would be a place for it on the
> > Apache site or elsewhere.  If there was a road map or outline for the
> > documentation desired that would be a start.
> >
> > -----Original Message-----
> > From: James Melton [mailto:james.melton@cylogix.com]
> > Sent: Friday, March 30, 2001 11:59 AM
> > To: general@xml.apache.org
> > Subject: Re: Help wanted: more qualified developers
> >
> > I don't think I have solutions, but I sure recognize some problems.
> >
> > 1. It takes a LOT of time to get involved in code development on one of
> > these projects. There is a ton of code of which I know 0% to start.
> > There seems to be no real architectural documentation that will help me
> > begin to get a grip. There are large documents from W3C that are not
> > light reading. There are an enormous number of emails on xalan-dev that
> > I can only scan without absorbing much (It's good as far as presenting a
> > lot of material, but bad in that I think I don't really know quite
> > what's going on). All this requires lots and lots of time.
> >
> > 2. Sorting out how to begin even on simple bug fixes is a problem. When
> > I read about bugs submitted by the community they often are not bugs,
> > but it takes an "expert" to make that call. I can find bugs in Bugzilla
> > but it would help if there was a status of "certified" applied by one of
> > the committers who should know if something really is a bug. Bugs are
> > the basic problems that people new to a code base can use to begin to
> > learn how things fit together. I will spend three weeks in my spare time
> > fixing something that you can fix in an hour or two of your work-day.
> > Given the heavy commitment (three weeks! of spare time that I honestly
> > don't have but steal from my family and employer) I really need to know
> > that I am working on the "right thing".
> >
> > 3. When you look from the outside you realize quickly that this is a
> > full-time paid job for some people. It is difficult to rationalize why I
> > am doing work for which you are getting paid. I understand why I want to
> > work on this code but I am damned if I can explain it to anyone else.
> > They just look confused like maybe they need to find professional help
> > for me :)
> >
> > To get more people you have to make it easier for people to be involved.
> > Consider documenting application architecture, documenting the
> > relationships between code and standards, categorizing bugs for new
> > developers, and issuing certificates of sanity that we can show to our
> > wives and co-workers when they ask, "What are you doing?"
> >
> > Jim.
> >
> > Scott_Boag@lotus.com wrote:
> > >
> > > A  good discussion to have is: how do we get better developer
> > participation
> > > on the existing apache projects?  Is there anything the PMC or the
> > projects
> > > can do procedurally to encourage more people to write code?
> > >
> >
> > ____________________________________________________________
> > James Melton                 CyLogix
> > 609.750.5190                 609.750.5100
> > james.melton@cylogix.com     www.cylogix.com
> >
> > ---------------------------------------------------------------------
> > In case of troubles, e-mail:     webmaster@xml.apache.org
> > To unsubscribe, e-mail:          general-unsubscribe@xml.apache.org
> > For additional commands, e-mail: general-help@xml.apache.org
> >
> > ---------------------------------------------------------------------
> > In case of troubles, e-mail:     webmaster@xml.apache.org
> > To unsubscribe, e-mail:          general-unsubscribe@xml.apache.org
> > For additional commands, e-mail: general-help@xml.apache.org
>
> --
>
> =================
> Matthew B Brandabur
> Senior Technical Writer
> iFS Group
> Oracle Corporation
> 500 Oracle Parkway
> Building 500, Room 466
> Redwood Shores, CA 94065
>
> 650-506-9766
>
> Matthew.Brandabur@oracle.com
>
> ---------------------------------------------------------------------
> In case of troubles, e-mail:     webmaster@xml.apache.org
> To unsubscribe, e-mail:          general-unsubscribe@xml.apache.org
> For additional commands, e-mail: general-help@xml.apache.org
>
> ---------------------------------------------------------------------
> In case of troubles, e-mail:     webmaster@xml.apache.org
> To unsubscribe, e-mail:          general-unsubscribe@xml.apache.org
> For additional commands, e-mail: general-help@xml.apache.org

--


=================
Matthew B Brandabur
Senior Technical Writer
iFS Group
Oracle Corporation
500 Oracle Parkway
Building 500, Room 466
Redwood Shores, CA 94065

650-506-9766

Matthew.Brandabur@oracle.com



---------------------------------------------------------------------
In case of troubles, e-mail:     webmaster@xml.apache.org
To unsubscribe, e-mail:          general-unsubscribe@xml.apache.org
For additional commands, e-mail: general-help@xml.apache.org


Mime
View raw message