[TYPO3] Documentation nightmare

virgil huston virgil.huston at gmail.com
Fri Mar 14 18:22:11 CET 2008


Andi,

There are two kinds of editors. One is more properly a copy editor and that
is the one who doesn't have to know much about what they are reviewing.
These are the editors we need for ensuring that grammar is good, finding
typos, and making sure things make sense. The other type is the editor that
checks to make sure everything actually works like the manual says, in
effect, one learns the software as one is editing. We need both kinds, since
the developer will often take some things for granted and someone not
familiar with the software will find the holes in the manual.

Virgil


On 3/14/08, Andreas Becker <ab.becker at web.de> wrote:
>
> Hi Dimitry
>
> +100 as a editor never knows about the inside of what the developer has
> created as good as the developer itself. BUT a developer could have an
> editor to whom he provides all necessary informations like most
> poltitician
> talks will be written not by those who speak but by ghost writers. Both
> need
> to be a very good Team then you get good documents. Especially if one is
> more like a developer and the other more like the one using the extension
> as
> i.e. editor.
>
> Thanks
> Andi
>
> 2008/3/14, Dmitry Dulepov [typo3] <dmitry at typo3.org>:
> >
> > Dan Osipov wrote:
> > > I actually prefer the wiki - people can make modifications and correct
> > > any errors in the article. They can discuss the article contents in
> the
> > > discussion section, and ask for help. Changes can be tracked through
> an
> > > RSS feed, much harder to do in the OO files.
> >
> >
> > I do not think this is a right way to write docs. Doc should be written
> by
> > author and reviewed by editor... Imagine TYPO3 Core API written by many
> > people, it will be chaos.
> >
> >
> > --
> > Dmitry Dulepov
> > TYPO3 core team
> > Web: http://typo3bloke.net/
> > Skype: callto:liels_bugs
> > "Nothing is impossible. There are only limits to our knowledge"
> > _______________________________________________
> >
> > TYPO3-english mailing list
> > TYPO3-english at lists.netfielders.de
> > http://lists.netfielders.de/cgi-bin/mailman/listinfo/typo3-english
> >
> _______________________________________________
> TYPO3-english mailing list
> TYPO3-english at lists.netfielders.de
> http://lists.netfielders.de/cgi-bin/mailman/listinfo/typo3-english
>


More information about the TYPO3-english mailing list