[Typo3-documentation] Previous message #2 (was: Fwd: Re: Help with Installation documentation?)

[Michael Stucki]

Subject: Re: Help with Installation documentation?
Date: Samstag, 12. Juni 2004 19.36
From: Michael Stucki <mundaun at gmx.ch>
To: peter.kindstrom at abc.se
Cc: jms at marktauftritte.ch, ledj-typo3 at dcmedia.biz

Dear Peter,

sorry for letting you wait so long. I already received your mail from April
 21 but didn't reply ever yet.

> I may be interested in helping a little with TYPO3
> documentation... I really dont know in which team documentation
> projects my skills and ideas are best used, but this is what I
> think about the Installation documentation project:

It is great that you want to contribute to TYPO3!

First, let me add a few notes:
I know I am at some list as the project leader for documentation stuff, but I
would really like this (all coordination etc.) to someone else.

There are a few people how worked on some documentation in the past few
 weeks, namely Lars E.D. Jensen and Jean-Marie Schweizer. I have added them
 to the CC field. Maybe one of you has some more stuff for this thread?

> I would like to help with structuring and "unifying" the
> installation documentation a bit. Now there are five different
> installation guides. These should be restructured so that there
> are two main documents:
>  * TYPO3 Installation Basics
>  * TYPO3 Upgrade Basics

Right. I have looked at your documents (I had the link from your first mail)
at http://www.infolagret.se/index.php?id=18.

Mostly, I'm with you. I already discussed the topic with Kasper and share
 some of his thoughts as well (see attached mail).

If you could improve the "Installation & Upgrade" manual according to your
needs, that would be great. If you think there's no chance to continue
working on that document and start with new ones, let's discuss this here.

> and then there could be additional guides for special
> installations
>  * TYPO3 Installation on Gentoo Linux	7
>  * TYPO3 Installation on Mac OS X	5
>  * TYPO3 Installation on Mandrake Linux

Plus the Debian manual, of course! :-)
What about Kaspers Redhat document? Did one of you ever look at this? My wish
would be that we remove all compilation-related stuff since this is
distrubition independent. What do you think?

> And with this as a start I like to try getting configuration
> information out of the install/upgrade documentation and form a
> new line of configuration documentation, like:
>  * TYPO3 Configuration Basics
>  * TYPO3 PHP Configuration
>  * TYPO3 Basic Templates
>  * TYPO3 Advanced Templates
>  * TYPO3 TypoScript By Example

Would be great if we had this, but it's a huge task! I don't think it's
realistic that this will ever be done, and moreover, Daniel Hinderink, René
Fritz and Werner Altmann are already (for several months now!) working on a
book which should cover such topics. Just ask them about how much time this
will consume!

In my opinion, it would be a great step if we only had a clean-structured
series of installation manuals (see above) where the main document should
include all important information while the distribution specific ones extend
this one and include some deeper information).

What do you think?

> I like to get a discussion about this idea and out of that
> discussion I like to deside if membership in the project is
> interesting or not (for me and the project). Of course I will
> get involved in other things than the above mentioned if I
> decide to join a project!

It's really great that you want to help our project. I would be happy if you
joined the team!

However, please keep in mind that writing documentation seems to be a very
ungraceful task. Have a look at some of the last topics on the Debian list.
Everybody will nag about your work but nobody will actually help you to
improve it. Just be aware of that! Simply ignore them.

Regards - michael
-------------- next part --------------
An embedded message was scrubbed...
From: Kasper =?ISO-8859-1?Q?Sk=E5rh=F8j?= <kasper at typo3.com>
Subject: Re: Old documents on typo3.org
Date: Fri, 30 Apr 2004 12:22:53 +0200
Size: 2401
Url: http://lists.netfielders.de/pipermail/typo3-project-documentation/attachments/20040613/fd2cdd5f/attachment.mht