[jboss-svn-commits] JBL Code SVN: r12134 - in labs/jbossrules/trunk/documentation/manual/en: Chapter-BRMS and 1 other directory.

jboss-svn-commits at lists.jboss.org jboss-svn-commits at lists.jboss.org
Fri May 25 05:09:20 EDT 2007


Author: michael.neale at jboss.com
Date: 2007-05-25 05:09:20 -0400 (Fri, 25 May 2007)
New Revision: 12134

Added:
   labs/jbossrules/trunk/documentation/manual/en/Chapter-BRMS/Intro1.png
   labs/jbossrules/trunk/documentation/manual/en/Chapter-BRMS/Section-Introduction.xml
Modified:
   labs/jbossrules/trunk/documentation/manual/en/Chapter-BRMS/Section-UserGuide.xml
   labs/jbossrules/trunk/documentation/manual/en/master.xml
Log:
documentation for BRMS

Added: labs/jbossrules/trunk/documentation/manual/en/Chapter-BRMS/Intro1.png
===================================================================
(Binary files differ)


Property changes on: labs/jbossrules/trunk/documentation/manual/en/Chapter-BRMS/Intro1.png
___________________________________________________________________
Name: svn:mime-type
   + application/octet-stream

Added: labs/jbossrules/trunk/documentation/manual/en/Chapter-BRMS/Section-Introduction.xml
===================================================================
--- labs/jbossrules/trunk/documentation/manual/en/Chapter-BRMS/Section-Introduction.xml	                        (rev 0)
+++ labs/jbossrules/trunk/documentation/manual/en/Chapter-BRMS/Section-Introduction.xml	2007-05-25 09:09:20 UTC (rev 12134)
@@ -0,0 +1,105 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD Simplified DocBook XML V1.0//EN"
+"http://www.oasis-open.org/docbook/xml/simple/1.0/sdocbook.dtd">
+<section>
+  <title>Introduction</title>
+
+  <para>This section introduces the BRMS. See the other relevant sections for
+  installation, usage and administration.</para>
+
+  <figure>
+    <title>The BRMS in action</title>
+
+    <mediaobject>
+      <imageobject>
+        <imagedata align="center" fileref="Intro1.png" format="PNG"
+                   scalefit="1" />
+      </imageobject>
+    </mediaobject>
+  </figure>
+
+  <section>
+    <title>What is a BRMS?</title>
+
+    <para>BRMS stands for Business Rules Management System.</para>
+
+    <para>This is the component of JBoss Rules which covers rule management,
+    storage, editing and deployment. A Web based user interface is provided so
+    this tool can be used by people who don't work in IDEs or text editors,
+    but it is intended for a wide audience.</para>
+
+    <para>A BRMS allows people to manage rules in a multi user environment, it
+    is a single point of truth for your business rules, allowing change in a
+    controlled fashion, with user friendly interfaces.</para>
+
+    <section>
+      <title>When to use a BRMS</title>
+
+      <para>You should consider a BRMS if any of the following apply to you:
+      You need to manage versions/deployment of rules, you need to let
+      multiple users of different skill levels access and edit rules, you
+      don't have any existing infrastructure to manage rules, you have lots of
+      "business" rules (as opposed to technical rules as part of an
+      application). </para>
+
+      <para>A BRMS can be used on its own, or with the IDE tooling (often both
+      together). </para>
+
+      <para>A BRMS can be "branded" and made part of your application, or it
+      can be a central rule repository.</para>
+
+      <section>
+        <title>When to not use a BRMS</title>
+
+        <para>In some situations applications may exist which have
+        the rules in a database (for instance as part of an existing application), 
+        and no new application is needed to manage the rules. </para>
+
+        <para>Otherwise, perhaps an existing rule management system and user interface
+        already exists (and is tailored to your environment already) - in this
+        case migrating to the BRMS may not be necessary.</para>
+
+        <para>If you are using rules to solve complex algorithmic problems,
+        and the rules are essentially an integral part of the application (and
+        don't need to be managed separately to the code).</para>
+      </section>
+    </section>
+
+    <section>
+      <title>Who uses a BRMS</title>
+
+      <para>The main roles of people who would use a BRMS are: Business
+      Analyst, Rule expert, Developer, Administrators (rule admins etc).
+      </para>
+
+      <para>The BRMS is designed in such a way as these different roles can be
+      accomodated, it can be controlled how much is exposed to different users in a safe fashion.</para>
+    </section>
+  </section>
+
+  <section>
+    <title>Features outline</title>
+
+    <itemizedlist>
+      <listitem>
+        <para>Mutliple types of rule editors (GUI, text)</para>
+      </listitem>
+      <listitem>
+        <para>Version control (historical assets)</para>
+      </listitem>
+      <listitem>
+        <para>Cateogorisation</para>
+      </listitem>
+      <listitem>
+        <para>Build and deploy</para>
+      </listitem>
+      <listitem>
+        <para>Store multiple rule "assets" together as a package</para>
+      </listitem>
+      
+      
+      
+      
+    </itemizedlist>
+  </section>
+</section>
\ No newline at end of file


Property changes on: labs/jbossrules/trunk/documentation/manual/en/Chapter-BRMS/Section-Introduction.xml
___________________________________________________________________
Name: svn:eol-style
   + native

Modified: labs/jbossrules/trunk/documentation/manual/en/Chapter-BRMS/Section-UserGuide.xml
===================================================================
--- labs/jbossrules/trunk/documentation/manual/en/Chapter-BRMS/Section-UserGuide.xml	2007-05-25 08:02:56 UTC (rev 12133)
+++ labs/jbossrules/trunk/documentation/manual/en/Chapter-BRMS/Section-UserGuide.xml	2007-05-25 09:09:20 UTC (rev 12134)
@@ -2,41 +2,8 @@
 <!DOCTYPE section PUBLIC "-//OASIS//DTD Simplified DocBook XML V1.0//EN"
 "http://www.oasis-open.org/docbook/xml/simple/1.0/sdocbook.dtd">
 <section>
-  <title>Introduction</title>
 
-  <para></para>
-
-
-  <figure>
-    <title>Overview</title>
-
-    <mediaobject>
-      <imageobject>
-        <imagedata align="center" fileref="all.jpg" format="JPG" scalefit="1" />
-      </imageobject>
-    </mediaobject>
-  </figure>
-
   <section>
-    <title>What is a BRMS?</title>
-    <section><title>When to use a BRMS</title></section>
-  </section>
-
-
-  <section>
-    <title>Features outline</title>
-    <itemizedlist>
-      <listitem>
-        <para>Textual/graphical rule editor</para>
-      </listitem>
-    </itemizedlist>
-  </section>
-
-  <section>
-    <title>Installation</title>	
-  </section>
-
-  <section>
     <title>Quick guide and concepts</title>	
   </section>
 
@@ -58,11 +25,6 @@
         <title>Rule authoring</title>
   </section>
 
-<!--
-  <section> 
-	<title>Syncronising with developers (SCM system integration)</title>
-  </section>
--->
 
   <section>
         <title>Integrating with your applications</title>

Modified: labs/jbossrules/trunk/documentation/manual/en/master.xml
===================================================================
--- labs/jbossrules/trunk/documentation/manual/en/master.xml	2007-05-25 08:02:56 UTC (rev 12133)
+++ labs/jbossrules/trunk/documentation/manual/en/master.xml	2007-05-25 09:09:20 UTC (rev 12134)
@@ -78,7 +78,7 @@
     </chapter>
 
     <chapter>
-      <title>Installation and Setup</title>
+      <title>Installation and Setup (Core and IDE)</title>
 
       <xi:include href="Chapter-Install/Section-Install.xml" />
 
@@ -129,6 +129,12 @@
       <xi:include href="Chapter-IDE/Section-QuickStart.xml" />
     </chapter>
 
+	<chapter>
+		<title>The BRMS (Business Rule Management System</title>
+		<xi:include href="Chapter-BRMS/Section-Introduction.xml" />
+	</chapter>
+
+
     <chapter>
       <title>The Java Rule Engine API</title>
 




More information about the jboss-svn-commits mailing list