From owner-freebsd-doc Thu Mar 26 19:59:31 1998 Return-Path: Received: (from majordom@localhost) by hub.freebsd.org (8.8.8/8.8.8) id TAA19104 for freebsd-doc-outgoing; Thu, 26 Mar 1998 19:59:31 -0800 (PST) (envelope-from owner-freebsd-doc@FreeBSD.ORG) Received: from mail1.realtime.net (mail1.realtime.net [205.238.128.217]) by hub.freebsd.org (8.8.8/8.8.8) with SMTP id TAA19098 for ; Thu, 26 Mar 1998 19:59:28 -0800 (PST) (envelope-from jktheowl@bga.com) Received: (qmail 15260 invoked from network); 27 Mar 1998 03:59:25 -0000 Received: from zoom.realtime.net (HELO zoom.bga.com) (root@205.238.128.40) by mail1.realtime.net with SMTP; 27 Mar 1998 03:59:25 -0000 Received: from barnowl (apm7-216.realtime.net [204.96.0.216]) by zoom.bga.com (8.6.12/8.6.12) with SMTP id VAA16925; Thu, 26 Mar 1998 21:59:22 -0600 Date: Thu, 26 Mar 1998 22:04:37 -0600 (CST) From: John Kenagy X-Sender: jktheowl@barnowl To: Studded cc: Docs Team Subject: Re: Doc projects and status In-Reply-To: <3519829A.E3A44CC6@dal.net> Message-ID: MIME-Version: 1.0 Content-Type: TEXT/PLAIN; charset=US-ASCII Sender: owner-freebsd-doc@FreeBSD.ORG Precedence: bulk X-Loop: FreeBSD.org Well, hope I'm not being redundant with discussions already had, but being less than technically expert, I need all the help I can get. Let me spill a little of my own learning experience with FreeBSD. On Wed, 25 Mar 1998, Studded wrote: > 1. Initiate discussion about the format for the final form of the docs. > I'd like to see a unified document (FAQ + Handbook + Tutorials + new > material) with a consistent style and extensive cross-indexing. I'd also > like to see a front end for this that takes the form of a "How Do I?" > index. That's just my view, but I think there's general consensus on the > first bit anyway. A unified format can be vital. What I have done here is to place all documentation (as far as practical) into a directory tree and in HTML format. I run apache and then run htDig on it all. I also have run htDig on www.freebsd.org. (It should be more restricted than that - it ran for hours.;-)) Then provided a page that points to the documents' tables of contents, to the "search" engine, or out to the internet. It is crude but it has the advantage of providing a single entry from all systems on the LAN. The documentation covers not only my system, but the current information at freebsd.org and the two are distinct. I do not have to peck through a lot of stuff to get to what I want. It has been _very_ helpful. > 2. Go through what we have with a fine-toothed comb prior to the docbook > conversion so that what's on the page now is as accurate and timely as > possible. This should be an ongoing "mid-term" goal that just about It is never ending as is the evolution of the OS itself. This will end up being a process rather than a product. Just thought I'd toss in my two cents about what I found useful. John To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe freebsd-doc" in the body of the message