[Typo3-doc] New documentation section at typo3.org / TER 2

Peter Kindström peter.kindstrom at abc.se
Tue Nov 8 18:34:33 CET 2005


Hi,
> I have chosen another structure for the new TER [4]. Please have a look at
> it - what would you like to change? We should create proper texts for the
> documentation section during the next three weeks so we can use them when
> the TER2 goes online.

Why not use the one from the wiki?

I have several times tried to explain it, so I try not to repeat
myself too much:

You should either structure documents by subject *OR* type of
document - not both. Why? Because where do people find the
installation tutorial? Or the reference for the Typo3 API?
See the problem?

Usually document structures are made *by* document managers,
*for* managers. Instead try to think how people do when the look
for a particular piece of information ! They often don´t know if
the information is related to a tutorial or referens, but they
are more likely to know the subject (I have problems with
logging in to the backend as an /admin/).

Do not make a structure based on what documents we have today.
Make a structure we can use when the amount of documents grow!

There is (at least now) a good thing to have the same structure
at both the wiki and typo3.org documentation pages! Then even if
it is not perfect, people will more easily *learn* where
documents are...

Have as few links to sublevels as possible at the first level.

Have one key word for the structure (like "role", "subject" or
"type of document") and make as few exceptions as possible from
that (not more than 2 or 3 in our case).


/Peter Kindström
BTW the wiki structure has been made with this in mind:
 - people always know their role (newbie, editor, admin, dev)
 - with common issues that doesn´t matter (tips, help, faq etc)
 - so not with extensions either
*One* clear idea behind the structure (=quite easy to learn?)
and only two exceptions (=easy to learn when it is an exception?).



More information about the TYPO3-project-documentation mailing list