[Typo3-documentation] Wiki structure

Peter Kindström peter289 at telia.com
Tue Jun 15 20:42:47 CEST 2004


>> Should we create big documents like "ExtDevGuide (XDG)" or should
>> we rather have many really small documents and then just a TOC
>> linking all of the small documents together? Or do we want that we
>> have a complete "Book" XDG?
> 
> I guess for a user it will be easiest if we could keep one clean TOC for 
> all manuals (wouldn't that be easier for linking too?).
> 
> Peter started one with the overall structure.

But then my "Overall document structure" should have been 
the wikis first page! ;-)

Because the "ExtDevGuide (XDG)" should be a document in the 
category "1.7 Developer Documentation" of the overall 
structure...

> 1 Overall document structure
> 1.1 Installation
> 1.2 Configuration
> 1.3 User Tutorials
> 1.4 User documentation
> 1.5 User Reference
> 1.6 Developer Tutorials
> 1.7 Developer Documentation
> 1.8 Developer Reference
> 1.9 Miscellaneous
> 1.10 Extension manuals

And dont forget that we probably will have other things then 
just manuals on the wiki. We maybe want to discuss 
documentation templates, writing conventions, info about the 
doc team, discussions about the typo3.org webpages and so on.

Hmmm, maybe we _should_ have the above structure as the TOC 
of the first wiki page? And add a few headers like:

  1.11 About the Documentation
  Information about the Doc team, projects, web pages, how to
  contribute and things like that.

  1.0 Documentation Rules & Strategy
  How to write documentations, rules, templates, tips and
  trix for writing. Also something about why we write
  documentation in a certain way.


But first, I like to hear what the "old" doc team thinks 
about my idea of an new structure. We should use the same 
structure in the wiki as in the typo3.org documentation 
library, I think.
If not, then the wiki structure doesn´t matter.


/Peter Kindström



More information about the TYPO3-project-documentation mailing list