Le projet de documentation de PhpMyObject

Tout bon logiciel sera utilisé. Tout bon logiciel ne disposant pas d'une bonne documentation verra ses auteurs envahis de questions et d'anomalies plus ou moins "bogus". Ceci est la raison d'être de ce projet. PhpMyObject a besoin d'une "excellente" documentation. PMO a comme objectif de rendre la vie d'un développeur beaucoup plus facile MAIS il ne réussira pas s'il ne dispose pas de la meilleure documentation qui soit.

Bien sûr, ceci va ralentir les livraisons puisque chacune d'entre elle devra être complètement documentée avant d'être publiée. Mais le bénéfice est réel, même en terme de développement. Tenter de créer un exemple et de le faire fonctionner amène souvent des anomalies ou des besoins à faire surface et aide à améliorer la qualité du produit.

Qu'allons-nous produire

• Un manuel d'introduction survolant l'utilisation de PhpMyObject à l'aide d'exemples simples
• Un manuel de l'utilisateur expliquant et démontrant toutes les fonctionnalités de la librairie à l'aide d'exemples allant du plus simple au plus complexe.
• Une documentation complète de l'API décrivant en détail chaque interface, classe et méthode de la librairie
• Un manuel technique destinés à ceux qui veulent modifier la librairie.