Discussion :

[Baptiste Wicht]

Bonjour à tous,

Je suis actuellement en train de travailler sur une application personnelle, sur laquelle je travaille seul, mais cela se pourrait qu'une ou plusieurs personnes me rejoignent sur cette application. Or, je n'ai pas la moindre documentation, sauf la documentation Javadoc du code, ce qui à mon avis ne suffit pas. J'ai aussi fait un diagramme de classe, encore incomplet pour le moment.

J'aimerais donc, dans mon intérêt et celui des possibles personnes qui vont me rejoindre, créer une documentation de ce projet.

Mais je ne sais pas vraiment par quoi commencer et quels documents il est utile de produire ?

Merci d'avance

[KiLVaiDeN]

Salut,

Selon moi, les documents que j'aimerais trouver si je rejoignais un projet seraient :

document d'études des besoins, pour savoir à quelle problématique l'application répond.

cahier des charges précis, afin de savoir ce qu'on fait, et quelles sont les charges et les choses à faire. Egalement une précision importante dans ce document, concerne la technologie utilisée, et les API utilisées, et comment elles sont utilisées

diagramme de classes si c'est un environnement objet, ou mcd si c'est porté sur un SGBD relationnel

quelques diagrammes d'use case pour les cas compliqués, avec des diagrammes de séquences si il y a des cas tordus

Voila.. selon moi avec ça t'es prêt

PS : tu as un projet sympa ?

A+

[Baptiste Wicht]

Merci de ton aide

Salut,

Selon moi, les documents que j'aimerais trouver si je rejoignais un projet seraient :

document d'études des besoins, pour savoir à quelle problématique l'application répond.

cahier des charges précis, afin de savoir ce qu'on fait, et quelles sont les charges et les choses à faire. Egalement une précision importante dans ce document, concerne la technologie utilisée, et les API utilisées, et comment elles sont utilisées

diagramme de classes si c'est un environnement objet, ou mcd si c'est porté sur un SGBD relationnel

quelques diagrammes d'use case pour les cas compliqués, avec des diagrammes de séquences si il y a des cas tordus

Voila.. selon moi avec ça t'es prêt

Je vais voir ce que je peut faire parmi tout ça, surtout cahier des charges, mais je veut pas être non plus trop pointu, c'est un projet personnel et j'ai pas de clients

PS : tu as un projet sympa ?

C'est JTheque, tu peut regarder dans ma signature

Ca commence gentiment à devenir assez gros, mais ca reste quelque chose de modeste, rien à voir avec les projets pro que l'on a au boulot.

[Nip]

Je rejoins KiLVaiDeN sur les documents necessaires.
J'ajouterai meme que la documentation du code est presque inutile, si les noms choisis pour les variables et methodes sont coherents. Dans la mesure ou le diagramme de classe est la pour assurer une vision globale de l'appli, que les UC sont aussi presentes (et tous, pas que pour les cas compliques, ca permet ainsi de correctement imager le cahier des charges et de s'en passer) et que un document sur les tech utilisees est dispo, ca me parait suffiasant pour un projet de petite ou moyenne taille.

[Baptiste Wicht]

Donc selon vous, il faudrait que je fasse :

• Un cahier des charges contenant obligatoirement l'utilisation des apis et le pourquoi de l'utilisation
• Un diagramme de classe complet
• Les usecase pour chaque cas

c'est bien cela ?

Comme j'utilise beaucoup de données en base, je me demandais si ca servait à faire un document expliquant chaque objet et ses caractèrristiques, par exemple un film représente xxx et possède les caractéristiques suivantes : xxx. Ca sert à quelque chose ou le diagramme de classe suffit ?

[Patriarch24]

un film représente xxx et possède les caractéristiques suivantes : xxx.

Tu parleras de ça dans le modèle du domaine (cahier des charges). Le diagramme de classe l'expliquera aussi (la classe "Movie" implémentant ce modèle) à son tour.

[KiLVaiDeN]

Comme j'utilise beaucoup de données en base, je me demandais si ca servait à faire un document expliquant chaque objet et ses caractèrristiques, par exemple un film représente xxx et possède les caractéristiques suivantes : xxx. Ca sert à quelque chose ou le diagramme de classe suffit ?

Salut,

Pour les données en base, je ne vois rien de mieux qu'un MCD.
Un diagramme de classe étant orienté objet, et pas tout à fait destiné à représenter un modèle relationnel, il sera beaucoup moins précis sur les dépendances etc..

Si tu peux rapidement faire un modèle MCD sur un outil comme Power AMC ( Power Designer ) je te le conseille vivement; C'est une information que je trouve vitale pour bien comprendre l'intention et la structure de la base de données.

A+

[Baptiste Wicht]

Bonjour,

Merci de vos réponses, je vais donc ajouter un MCD à ma documentation

[Nip]

Bonjour,

Merci de vos réponses, je vais donc ajouter un MCD à ma documentation

Sans vouloir etre rebarbatif MCD == Diagramme de classe, donc soit l'un soit l'autre et etant donne que tu as deja des UC, je serai d'avis a ce que tu gardes uniquement le DC, histoire de conserver le meme langage de modelisation.

[Baptiste Wicht]

Sans vouloir etre rebarbatif MCD == Diagramme de classe, donc soit l'un soit l'autre et etant donne que tu as deja des UC, je serai d'avis a ce que tu gardes uniquement le DC, histoire de conserver le meme langage de modelisation.

J'ai pas encore les Use-Case, faut encore que je les fasse

De plus, je pense que ce serait pas mal d'avoir une vue unique sur les données sans avoir tout les autres objets métiers, ca permet d'avoir rapidement un apercu des données de la base.

Donc je ne pense pas que ce soit redondant. Mais ce n'est que mon avis