[TYPO3-doc] purpose of wiki [update]

Daniel Brüßler info at -remove-patchworking.de
Thu Mar 15 16:14:33 CET 2007


Hello Jakub,

hm. I think about your answer. Could be very important.

Question: What is your definition of "the documentation developer"?

kind regards
Daniel Brüßler



Jakub Tesinsky schrieb:
>> For newcommers: I hope they easily find what they need - and have it
>> easy to make changes and additions.
> 
> I do not think that its that easy ... or at least it was not easy for
> me, because I considered wiki beeing documentation itself, not the
> working place for documentation efforts.
> 
> Concernig help: I would surely try to help if wiki was ment as I have
> seen it before - the documentation portal, because I would be part of
> intended audience. However, as I see it now - as working place for
> documentation efforts - I am not sure whether I am able to help without
> beeing the intended user of wiki - the documentation developer.
> 
> Jakub
> 
> 
>> Hi Jakub,
>>
>> I see you now understand it. what about helping me with this?
>>
>> For newcommers: I hope they easily find what they need - and have it
>> easy to make changes and additions.
>>
>> The question-feature: This is not a replacement for a forum, it is a
>> help to find problems or questions within 850 wiki-pages. ;-)
>>
>> kind regards
>> Daniel Brüßler
>>
>>
>> Jakub Tesinsky schrieb:
>>> Thanks Daniel for explanations,
>>>
>>> I understand the purpose of wiki better now. I suggest that it is
>>> clarified on the homepage of the wiki itself, that:
>>>
>>> **It is NOT the documentation portal, it is only working space for
>>> documentation team and the real documentation is placed elsewhere
>>> [link].**
>>>
>>> Comment: it might be obvious for YOU, but clearly not to somebody new to
>>> typo3 who have just found the wiki - mediawiki engine is commonly used
>>> on web for the REAL documentation - your usage is not as common. Also
>>> the overall structure of wiki homepage strongly suggest that the wiki IS
>>> intended as documentation itself, it stars with prominent links like:
>>> Getting started or the link Editors is explained like: ... Here you FIND
>>> documents on how to ... This should be changed to something like: "Here
>>> we work on documents on how to ..."
>>>
>>> Also if you want to attract help from "just passing" people, you should
>>> clearly state how they can help you, and what could be their place in
>>> your work flow. If it was the usual situation (documentation wiki
>>> portal) one would expect to browse for the document s/he is interested
>>> in, read it and may be make corrections of expand it. But (if I
>>> understand it) you probably want from "newcommers" only to find the wiki
>>> document with link to real document and perhaps leave the message on
>>> this wiki page with question (using the question tag). Or maybe then can
>>> help you with proofreading ... I do not know.
>>>
>>>
>>>
>>>
>>> Daniel Brüßler napsal(a):
>>>> Hi Jakub,
>>>>
>>>> We have two steps:
>>>>
>>>> == now ==
>>>> * who does it: everybody
>>>> * collection of texts and images -- what should be changed or included
>>>> into the OO-documents what are in TER
>>>> * setting of the state of the wiki-page -- using a tag what you see at
>>>> http://wiki.typo3.org/index.php/Teamwork
>>>> ** e.g. draft doc: {{Tag|draft}}
>>>> ** e.g. finished doc: {{Tag|finished documents}}
>>>> * when it's finished and reviewed the doc-owner can change the OO-doc
>>>> and re-upload it into TER.
>>>>
>>>> == soon but still takes some time ==
>>>> * button for import and export on every wiki-page for OO-doc-format and
>>>> DocBook-format
>>>>
>>>>
>>>> You understand now?
>>>> kind regards
>>>> Daniel Brüßler
>>>>
>>>>
>>>> Jakub Tesinsky schrieb:
>>>>> May be I have found the key question which can solve my overall
>>>>> confusion. On the Main page of the wiki the mission of wiki is clearly
>>>>> stated:
>>>>>
>>>>> The purpose of this wiki is to optimize the Official
>>>>> OpenOffice-documents by Teamwork.
>>>>>
>>>>> BUT, how this is ahieved? Are there OO documents imported in wiki
>>>>> and is
>>>>> there somebody who implements improvement in wiki to OO documents?
>>>>> Or is
>>>>> there some finer workflow plan?
>>>>>
>>>>> Jakub


More information about the TYPO3-project-documentation mailing list