[Typo3-documentation] Comments on june 15th version of the OTOC
Peter Kindström
peter289 at telia.com
Thu Jun 17 00:18:25 CEST 2004
> 1-Server / Browser compatibility chart
> Should go in installation section IMHO.
Ok for me. I have not read all documents...
> 2- Configuration
> The text below helps a bit but for me Templates & Navigation should own his
> section.
> Security could be part of installation?
> Should Configuration just hold Security,Users&Groups management, Sysadmin
> guide ?
>
My new suggestion is that this section is moved into another
section. I will come back to that in a new wiki version of
the structure...
> 4-Advanced Installation
> Needed ? Why not part of Troubleshooting at the end of Installation basics ?
You are probably right! But if troubleshooting becomes big
and/or very detailed maybe there could be an idea to lift
out some parts into a separate document?
(I think that some deep tech details in the existing
tutorials interrupts "the flow" and should be moved to
appendixes or separate documents...)
> 5- User Tutorials
> What is a "user" ?
> Maybe the Getting Started should go in Installation ?
> MTB1-2&3 and FTB should go in Templates & Navigation (if we agree on that
> one)
Kasper suggests three "target groups": User, Administrator
and Developer. And I agree, this is a good and easy way to
structure documents by. Easy for us and easy for the visitor
to know which he/she belongs to.
Right now I dont think there are any User documents for
Typo3 - but I think thats something we really should produce!
> 7- Developer Doc should go before dev tutorials
I wanted to have the same substructure for all target groups:
Tutorial
Manual
Tips and Troubleshooting
References
This is very near Kaspers own suggestion, but he uses
"Examples" instead of "Tips and Troubleshooting".
And I think this substructure is good...
> 8- User reference is not needed if I can find somewhere to put the
> Glossary...
Not right now, but I am not making the structure to just fit
right now - I want it to fit later on too! If it is going to
be the overall structure, we should also take in
considuration what is missing today and what we might get it
in the future.
This overall structure should be reflected on the Matrix
page and should be completed with some sort of roadmaps like
you have suggested for the typo3.org web pages in another mail.
/Peter Kindström
More information about the TYPO3-project-documentation
mailing list