Re: Apache Doc Project

At 12:28 PM 11/4/98 +100, you wrote:

>Don't flame me, but what I have in mind is a far more drastic move toward an
i had
>something more concrete, but as the bazaar theory teachs...

Far from flaming - I think everything you're suggesting here is right on.

>Call it Project Guidelines.
>
>1. a set of book-style docs covering the various aspects of deploying a
oriented.

It was in an effort to establish this sort of orientation that I came up with the outline I forwarded. I doubt too many business types will understand or even care about phrasing like "module mod_log_referrer" or "log file format". Most businesspeople just want to know that something works, not how and why it works. And they want to know in terns they understand what it can do for them.

> For example, here is the place where to cover aspects as power

Good point, and relatively easy to accomplish. FrameMaker, HotMetal, Doc-to-Help - all do this kind of thing.

>Moreover, define a

Do you need help?

In addition to our free technical library, Pantek provides professional IT services to companies who utilize Open Source software: Learn more about Pantek's Technical Support offerings Place an order for 24/7/365 Technical Support here Learn more about Pantek, who we are, and what we do Chat with a Live Operator Related httpd.apache.org Links announce bugs cvs dev docs gui-dev modproxy-dev packagers testers Request more information about Pantek

This might be outside our area of responsibility. Seems to me the members of the core group of developers would have to contribute to/agree to this.

 There is even the need of documentation affording the internal
> architecture and design of the Apache software (as suggested by

You must be psychic. This is another suggestion that several of the core group made to me when I originally aproached them re: helping out.

>4. build a DocPortal as proposed by Kraaij, and evaluate the needs of writing

Once again, I agree. I'd suggest case studies of existing Apache implementations of a number of degrees of sophistication, as well as studies/popularizations of our efforts.

>6. in which format/structure must we produce this bunch of data?

These aren't the only decisions of this kind. We'll also need to provide for a variety of means of delivery.

>7. don't forget the target of it all! Query the Apache user base for which kind

Do you need more help?

In addition to our free technical library, Pantek provides professional IT services to companies who utilize Open Source software: Learn more about Pantek's Technical Support offerings Place an order for 24/7/365 Technical Support here Learn more about Pantek, who we are, and what we do Chat with a Live Operator Related httpd.apache.org Links announce bugs cvs dev docs gui-dev modproxy-dev packagers testers Request more information about Pantek

I can get started with this one. I have associations with several environments which run Apache - an engineering firm I used to do documentation work for, and the college at which I currently teach. I'll start asking questions to the system and network administrators at both those sites.

>
>I'm the first in realizing that the challenge I pose here is VERY ambitious.

Ambitious and stimulating indeed! I think the possibility of aiding and influencing the acceptance of something like Apache is exciting and worthwhile.

Take care.

Michele Received on Wed Nov 04 15:22:24 1998