[Typo3-documentation] Extension Documentation

[Christian Trabold]

Hi ya!

>> http://wiki.typo3.org/index.php/tt_news
>> -> find anything about tt_news incl. tutorials, manual etc.
> 
> There will only be few extensions for which multiple documents exist.
> Many will just have one page of documentation, thus your concept would 
> lead to many pages (e.g. /tt_news) containing nothing but ONE link to 
> its subpage (/tt_news/manual). In that case it would be better if the 
> manual would be located directly at /tt_news.
> 
>> http://wiki.typo3.org/index.php/tt_news/documentation/
>> -> the place for docs about the plugin tt_news
> 
> 
> Make it shorter, /docs instead of /documentation.

You're right. But in some cases it might be more user friendly to write 
words as is.


>> http://wiki.typo3.org/index.php/tt_news/documentation/manual
>> -> the place of the manual for tt_news
> 
> 
> I'm no native english speaker, thus I have a question: What's the 
> difference between the word "documentation" and "manual". I always 
> thought it would be more or less the same.
> Consequently I regard /docs/manual as redundant.

Well, me neither. But in my point of view, documentation is the "whole" 
stuff written about a given tool/extension. "Manual" is a special piece 
of paper, which includes first steps, technotes and guides you to a 
curtain point.


>> <http://wiki.typo3.org/index.php/documentation/extensions/tt_news/manual/> 
>>
>> -> tt_news manual
> 
> This gets incredibly long.

Yes it's too long. The example should only make clear what I meant :)


> 
> My proposal is:
> 
> If there is only one doc for an extension, just locate it at:
>   /ext/tt_news
> 
> If there is more than one document, make an overview at:
>   /ext/tt_news
> the turorial for tt_news should then be at:
>   /ext/tt_news/tutorial
> and the reference at
>   /ext/tt_news/reference
> 
> If you agreed to that, I would ask Kasper to link the extensions that 
> don't have any docs to http://wiki.typo3.org/index.php/ext/extkey

Great!


Christian