Documentation
Cette page décrit simplement les trois niveaux de documentation disponibles avec la plateforme Uranie. Tous ces niveaux sont directement accessibles sur ce site mais seul les deux premiers (manuel méthodologique et manuel utilisateur) sont toujours fournis précompilé avec les sources d'Uranie. Le troisième, manuel développeur, optionnel, est recompilé si demandé sur les machines pour décrire techniquement l'implémentation de la plateforme. Toutes les documentations détaillées ici ne sont écrites qu'en anglais. Pour trouver quelques descriptions pédagoqiques de méthode, vous pouvez aussi aller voir les notices pédagogiques mis-à-disposition ici.Une nouvelle version de la documentation est en réécriture depuis quelques temps pour simplifier la vie des développeurs et automatiser toujours plus les tests et le déploiement des versions (ainsi que la mise à jour de ce site). Elle est basée sur Sphinx et produit trois nouveaux chemins accessible dans le menu et ci-dessous. Cette nouvelle documentation n'est pas encore complète, il manque certaines parties toujours en cours de transcription.
Les différents niveaux de documentation
Cette documentation a pour but de fournir les bases méthodologiques utilisées tout au long de la plateforme. L'apport principal de cette documentation est une description brève mais complétée par des références pour renvoyer vers les articles de la litérature.
Cette documentation, exhaustive, a pour but de présenter les méthodes tant du point de vue de leur utilité que du point de vue de l'implémentation, y compris l'interface (classes, dépendances, héritages) et les possibles options. Chaque module est présenté de manière séparé après une introduction générale de la plateforme et de son organisation. Cette documentation contient un très grand nombre d'exemples, largement discutés et détaillés et qui sont appelés cas d'utilisation (use-cases).
Cette documentation, exhaustive, a pour but de présenter les méthodes tant du point de vue de leur utilité que du point de vue de l'implémentation, y compris l'interface (classes, dépendances, héritages) et les possibles options. Chaque module est présenté de manière séparé après une introduction générale de la plateforme et de son organisation. Cette documentation contient un très grand nombre d'exemples, largement discutés et détaillés et qui sont appelés cas d'utilisation (use-cases).
Le manuel développeur est une description détaillée des méthodes en terme d'implémentation et est directement issu de ce que les développeurs ont prévu de partager pendant la rédaction du code. Ce niveau de documentation est extrait du code en lui même via Doxygen et n'est généré que lors de l'installation de la plateforme, seulement si ce niveau est demandé. Cet aspect est discuté dans la FAQ
Cette documentation a pour but de fournir les bases méthodologiques utilisées tout au long de la plateforme. L'apport principal de cette documentation est une description brève mais complétée par des références pour renvoyer vers les articles de la litérature.
Cette documentation, exhaustive, a pour but de présenter les méthodes tant du point de vue de leur utilité que du point de vue de l'implémentation, y compris l'interface (classes, dépendances, héritages) et les possibles options. Chaque module est présenté de manière séparé après une introduction générale de la plateforme et de son organisation. Cette documentation contient un très grand nombre d'exemples, largement discutés et détaillés et qui sont appelés cas d'utilisation (use-cases).
Cette documentation, exhaustive, a pour but de présenter les méthodes tant du point de vue de leur utilité que du point de vue de l'implémentation, y compris l'interface (classes, dépendances, héritages) et les possibles options. Chaque module est présenté de manière séparé après une introduction générale de la plateforme et de son organisation. Cette documentation contient un très grand nombre d'exemples, largement discutés et détaillés et qui sont appelés cas d'utilisation (use-cases).