[TYPO3-doc] Domain model for documentation

[Philipp Gampe]

Hi François,

François Suter wrote:

> As this is really experimental for now, Fabien has been using a Github
> repository. We'll move to the TYPO3 Git repository when we're closer to
> something stable.

IMHO github is a perfect place for collaboration, because it makes working 
on code together very easy.

> Today I completed the domain model that Fabien had started and it raised
> several questions, on which I would like to have your opinion:
> 
> 1) first and foremost, Fabien created a model called "Documentation",
> which represents one version of one manual for one extension/package. I
> would propose to call this model "Manual" instead, because it fits the
> domain better IMO. In particular "Documentation" is a mass noun, which
> means it is not supposed to be plural, so we're not supposed to have
> methods like "getDocumentations()". Any opposition?

not really

> 2) about the version number field: do we want to be fully open about
> this or should we validate it agains an "x.y.z" schema?

The only requirement would be that it allows less or more comparisons.

> 3) about the language, same question: should we validate it against a
> "xx_YY" schema?

Yes. Actually it should match the core scheme (if possible), but I would go 
for ISO (or whatever the en_US, de_DE standard is).

> 4) more importantly, how about the handling of authors? In the version I
> committed I created a many-to-many relation to Persons (as in
> \TYPO3\Party\Domain\Model\Person). This model has a name and an e-mail
> address, but not more. Do we want to extend this with an Author model?
> The advantage is that it could be related to a company (another Party)
> and have a reversed relation to the manuals, so that you could actually
> look up all the manuals a person has worked on. What do you think?

I would like to have a reverse lookup and I would prefer if authors are 
related to t3o persons and/or teams.

Best regards
-- 
Philipp Gampe – PGP-Key 0AD96065 – TYPO3 UG Bonn/Köln
Documentation – linkvalidator
TYPO3 .... inspiring people to share!