[Typo3-doc] DocTEAM first goal = the structure
Rainer (Rene) Suthoelder
t3 at boswel-remove-me.de
Wed Dec 22 11:18:48 CET 2004
sylvain,
currently, i'm doing a little personal networking for finding a suitable
typo3 documentation structure.
by fortune, a former colleague is responsible for the whole documentation
process for a very well known ERP system.
as a starting point, she pointed me to this document
http://help.sap.com/content/additional/docutypes/info_docutypes.htm.
there, you can see how they organize their documentation in general. i must
admit that the structure really makes sense (to me, at least) and maybe the
t3 docteam could adopt some parts...
i like the idea of "Documentation types in the software life cycle". from
the illustration you get a visual hint where in the available documents to
search for information.
the glossary (SAPterm) together with the core documents (SAP Library,
description of _all_ SAP functions) are there to accompany you all the time,
they provide the general information and explanations. (besides: this again
shows that the glossary is not just nice to have, in my eyes it's crucial).
the other documents are there to support you in the various phases of an
implementation or while running and maintaining the system.
reading their document, i started to think about putting existing t3 docs in
the various sections and that was pretty easy.
they also work with target groups to further structure the documents.
perhaps the docteam may draw something out of this work. i think i could
assist yoy in getting more detailed information on their documentation
process.
greets,
rainer
More information about the TYPO3-project-documentation
mailing list