discuss: GUIDE in Wiki, example of the LVM-HOWTO
Subject:
Re: [discuss] GUIDE in Wiki, example of the LVM-HOWTO
From:
"Svetoslav Petkov Chukov" ####@####.####
Date:
17 Dec 2008 11:22:52 +0000
Message-Id: <e29b0db60812170321y12e4837en44fd5df65c3a47bd@mail.gmail.com>
I agree,
Actually I think we should reconsider the type of the documents.
HOWTO - A document that describes information how one can achieve specific
task, result or target. So, the document should be more like a step-by-step
approach.
The document could be in the following basic structure:
- do that.
- execute that command
- run this script
- etc...
-- additional information, history and some technical and theoretical
information.
GUIDE - A document that discuses information about specific topic with more
than one step-by-step approach or includes more complicated and mixed
information about other topics.
The document could be in the following format:
- information about the topic 1
- information about the topic 2
- information about the connection between them
- etc...
-- additional information, history and some technical and theoretical
information.
TUTORIAL - A document that contains several GUIDEs or HOWTOs.
I really think we should have a look about that definitions. The whole
documentation repository is based on them. So, we should define the
documents not because of their size but there basic structure. If a
particular document matches a target structure then it should be qualified
by that structure.
--
Svetoslav Petkov Chukov
On Wed, Dec 17, 2008 at 11:05 AM, jdd for http://tldp.org ####@####.####
> Hello again :-)
>
> The LVM-HOWTO (http://wiki.tldp.org/LVM-HOWTO), now looking for a new
> maintainer, is a very big HOWTO, so I suggest we change it to a GUIDE.
>
> We didn't yet discuss how a guide can be held in the wiki.
>
> I doubt it can be held as one page, because it's very inconvenient to
> edit. I suggest we use a "partX" system, dividing the GUIDE in smaller
> parts (wiki manageables).
>
> I setup a frame here:
>
> http://wiki.tldp.org/LVM-GUIDE
>
> Right now this frame is empty, waiting for your suggestions. If you
> agree, I will move the relevant HOWTO parts.
>
> If we use this system, We could empty the old HOWTO, letting in only a
> link to the new guide.
>
> With this system, we can submit each part separately and upgrade them
> also separately (each part having links to the other).
>
> jdd
> --
> jdd for the Linux Documentation Project
> http://wiki.tldp.org
> http://www.dodin.net
>
>
> ______________________
> http://lists.tldp.org/
>
>
