[TYPO3-doc] Peer review process
François Suter
fsu-lists at cobweb.ch
Wed Jul 14 11:56:06 CEST 2010
Hi,
> As I am more into the Skinning documentation, it sounds obvious for me
> to have one review at least from one of the both Steffen for everything
> concerning the Sprites / CSS API.
Sure. However I would this to be an internal process of the teams
working on each document. If a team submits a document for peer review,
I would expect that it is approved internally.
> So, the document should be advertised on this list for a +1. This is
> your idea, isn't it?
Yes.
> Also, is it a recommendation about where to store the track of the
> document? Should we maintain a Changelog file à la "doc_core_api" or
> rather on the document itself?
A Changelog file is better as change logs can become quite long. However
we have planned to have a "What's new" section in the new official
template, that could be used for highlighting the most important
changes. It could also link to a page in the wiki for example.
> Off topic: BTW, I don't like OpenOffice.org to write documentation... It
> is slow and buggy! We should definitely keep an eye on what has v5,
> maybe there would be some cooking recipe to take over.
I have planned a chat with Robert in August on that topic. There's
definitely a will to converge with the v5 team on the documentation side
of things as well. However we'll probably need manpower to implement
changes as it's not just about changing tool and format. The manuals are
recognized by the TER and by the Extension Manager, so these are parts
that would be impacted too.
Cheers
--
Francois Suter
Cobweb Development Sarl - http://www.cobweb.ch
More information about the TYPO3-project-documentation
mailing list