[Typo3-documentation] Short response... I promise! :-)

[Johannes Reichardt]

>Okay... then perhaps I will start with the MTB, Part I as an example.  In
>this post I will give bullet example of the process I see undertaking -- 
>don't worry, I understand it must then be *done* not just written about.
>:-)  I just hope the others follow! :-)
>  
>
Please... ;)

>  
>
>>I agree if you want to take the hard road by working with SXW, go ahead.
>>There is a documentation about how to write for typo3.org by Kasper
>>somewhere with all the regulations you'll need.
>>
>>    
>>
>
>I think if docs are made available (as they are currently) then all should
>be equivalent, not different; i.e., PDF = SWX = HTML
>and WIKI = PDF/SWX/HTML + Next Release Changes.
>
>  
>
>>I encourage you to work with the Wiki because then you'll have support
>>immediatly or at least faster than with SXW (just because it's to
>>complicated to work in a team that way).
>>    
>>
>
>I don't think any tool is exclusive ... I just think a defined process will
>make things better... here is my "graphical" attempt: in bullet points using
>MTB document as example (no long paragraphs!) :-)  I will post a flow chart
>diagram online when I get a chance.
>
>Initial Steps to begin new document process:
>#A - Define/Write document update procedures and/or policies for updating in
>Wiki
>
>#B - Write a "How to use the documentation" document for newbies, which
>gives overview of document info and what the versions mean
>
>#C - Create newsgroup for document
>
>#1-->Quick/Minor clean up SWX, Version 1.0, List Dependencies (cms v3.6.0+,
>automaketemplate v0.1.0, doc_tut_templselect 0.1.0)
>
>#2-->Convert to PDF Release 1 (Skip HTML since Wiki will provide that, or
>keep if OOo or some TYPO3 plug-in makes this easy)
>
>#3-->Create Wiki version (version 1.1, Beta/RC) of document (not just
>link... is there a tool for this yet?)
>
>  #3A-->Bug database status checked for related items / issues, information
>Wiki-ed into "Known Problems"
>  #3B-->Newsgroup Discussions reviewed for FAQ's, Common Problems / Fixes,
>etc -- added to appropriate section of Wiki document version
>  #3C-->Document updates are made to "Corrections" section of Wiki document
>(includes spelling, code changes, etc.); format simple like p23 - Corrected
>spelling of "wrod" to "word"
>  #3D-->As corrections are made, document "manager" updates Wiki, applying a
>"color" to updates to indicate what has changed
>
>#4-->Document "manager" determines many problems, work arounds, bugs (or
>whatever) have been documented, prepares document for next "release"
>
>#5-->Wiki Document is updated, Change Log is Detailed (for major items, not
>misspellings) --> Converted to SWX/PDF/HTML (see comments above) with new
>version number, Version 1.1
>
>#6-->Wiki Document now becomes v1.2 beta, and Corrections section is emptied
>and process starts again at Step #1, or Step #C for new document.
>
>When I get time, I will post examples on my website (once I can finish
>building it in Typo3!) of many newsgroup threads which support my theories,
>a visual diagram of the process, and the sample documents I mentioned above.
>And if I get any extra time, perhaps setup a Wiki even to show as a complete
>example.  The above steps not in stone... just what was on my mind.  More
>tedious? Yes. Resolve more problems? *I* think so.
>
>
>_______________________________________________
>Typo3-project-documentation mailing list
>Typo3-project-documentation at lists.netfielders.de
>http://lists.netfielders.de/cgi-bin/mailman/listinfo/typo3-project-documentation
>
>  
>