Tout logiciel de qualité se doit d’être accompagné de la documentation permettant d’en comprendre le fonctionnement et de pouvoir en exploiter toutes les fonctionnalités.

L’équipe de développement de MRules considère ce point comme essentiel. Notre documentation s’adresse donc à tous les intervenants des projets intégrant notre logiciel. Pour ceci, différents niveaux de détails et différents points de vue utilisateur sont adressés.

Vous trouverez sur cette page un sommaire de toute la documentation proposée en ligne, et ce par produit.

Documentation Transverse

• La section Nos Produits offre une vision globale de nos produits et de leurs interactions.
• Vous pouvez également découvrir les différentes extensions et démonstrations fournies avec MRules. Le code source associé vous permettra d’apprendre par l’exemple et de démarrer très simplement vos premiers projets.
  • Plus particulièrement, les détails de la grammaire de configuration offerte par l’extension de DSL pour le moteur de règles est disponible ici.
• Enfin, la section Javadoc ouvre la documentation standardisée Java, à destination des développeurs. La Javadoc des anciennes versions peut être consultée ici.

Documentation Framework

• La section Architecture offre une vision globale de la librairie, de ses composants et des interactions avec les autres briques logicielles.
• Les sections Logging et Accès aux Données et Conversions permettent d’entrer plus en détail dans les framework techniques sur lesquels le fonctionnement et les performances de la librairie sont basés.

Documentation Moteur de règles

• Ces deux articles fournissent des informations générales sur les cas métiers adaptés à l’utilisation de MRules et sur notre positionnement par rapport aux autres types de moteurs de règles.
• La section Architecture offre une vision globale de la librairie, de ses composants et des interactions avec les autres briques logicielles.
• La section Intégration propose de détailler la configuration, la création et l’utilisation d’une instance du moteur de règles.
  • La section Cycle de vie présente les différentes phases de la vie d’un ruleset.
  • Dans la section suivante, vous verrez comment Construire cette Instance.
  • Ici, vous apprendrez comment stocker la configuration de votre ruleset.
  • Après l’avoir construit, vous devrez Accéder aux Instance.
  • Enfin, un Tutorial est disponible pour récapituler les différentes étapes d’intégration et expliciter l’utilisation de MRules dans une application.
• La section Addons décrit les différents composants intégrés nativement à la librairie.
  • Les Accesseurs.
  • Les Conditions.
  • Les Opérateurs.
  • Les Exécutables.
  • Les Callables.
  • Les Fabriques de Context.
  • Pour touys les addons, un index détaillés de leurs Propriétés.
  • Enfin, un exemple montrant comment développer cos propres addons pour couvrir des besoins spécifiques
• La section Variables détaille l’utilisation des variables, qu’elles soient globales ou locales.

Documentation Moteur de grammaire

• La section Architecture offre une vision globale de la librairie, de ses composants et des interactions avec les autres briques logicielles.
• A venir, la documentation sur la création de grammaire personnalisée est en cours de rédaction.

Extensions et Démonstrations

• La présentation de toutes les extensions à nos produits est ici.
  • Vous pouvez également consulter le détail de notre extension « DSL pour le Moteur de Règles« .
  • Et voir la documentation générée de la grammaire.
• La présentation de toutes les démonstrations de nos produits est ici.