[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: HOWTO vs mini-HOWTO [was: Linux Doc Infrastructure]



On Thu, 13 Jan 2000, Morten Kjeldgaard wrote:

> On Thu, 13 Jan 2000, der.hans wrote:
> 
> > I've dropped gnome-doc off, since my reply is only about my proposed
> > removable drive HOWTO.
> 
> I understand your comments, but I was only talking about your document as
> an example, one little corner of the entire LDP. My point is that we want
> to have small documents tied together by a organizational structure of
> documents. It is better if you author 3 small documents rather than 1 big
> one.

The problem is that if we list each of the small docs we end up with a
massive clusterf##k which is a pain to use :).

I think that's part of the problem now. I would rather see large docs with
exportable chapters than a bunch of little sticky notes.

I guess, however, it would work with a bunch of small individual chunks if
the big virtual docs were presented at the front.

The post earlier today about the networking docs is a prime example. Also
when I first set up my orb I had to look at 3 docs for content that
should've been in one doc that was not dependant on the brand of medium in
question.

I think the fastest change we'll see is if we drop the distinction between
howto and mini-howto and put in an organized index, similar to the type of
thing you'd find in the back of a technical book.

I think the categories of docs should be sgml docs that meet the ldp reqs,
e.g. no graphics dependancies, sgml docs that don't meet the ldp reqs,
texts that aren't sgml and manuals. Manuals are a great candidate for
being virtual packages.

I'll help with the indexing. It's a project I wanted to get to next month
anyway :).

ciao,

der.hans

> /Morten

-- 
# +++++++++++=================================+++++++++++ #
#                 der.hans@LuftHans.com                   #
#            http://home.pages.de/~lufthans/              #
#   I'm not anti-social, I'm pro-individual. - der.hans   #
# ===========+++++++++++++++++++++++++++++++++=========== #


--  
To UNSUBSCRIBE, email to ldp-discuss-request@lists.debian.org
with a subject of "unsubscribe". Trouble? Contact listmaster@lists.debian.org