Bookshelf v7.5: Sample Project Design Documentation

Developing and Deploying Siebel eBusiness Applications > Introducing the Business Case >

Sample Project Design Documentation

The types of documents listed in this section capture the business requirements and detailed design of NREC's Siebel solution. These documents are outputs of the design stage of the Siebel eRoadmap implementation methodology. They define the scope of the solution and document the detailed specifications needed to configure the system.

Design documentation is a critical part of an implementation. Customers can submit these documents to Siebel Expert Services for a design review. If all documents are not submitted or the templates are not used to guide them through the documentation process, the customer may omit important information and reduce the value of the review.

The types of documents used to capture the system design are:

Entity Relationship Diagram. This type of diagram (See Figure 2) shows the relationships between the major entities that will be part of NREC's solution. Entities include object definitions such as business components and business objects.

Business Component Design. The business component design template is used to define the properties of business components, including the user properties, joins, single-value fields, multi-value fields, and multi-value links.

Business Object Design. The business object design template is used after business components are designed. The template allows you to group business components and identify links between business components. This allows you to show the parent and associated child records in the user interface.

Applet Design. Applet designs are created after the implementation team decides what entities to track in their Siebel applications. Applet designs are reference documents created for each applet in the system. They comprehensively document an applet's properties, the fields that will be available on the applet, and the properties associated with each field. They should also include a mock-up or screen shot of the applet.

View Design. View design documentation should show what applets are part of the view definition, identify any special visibility associated with a view, for example, a My Team's View or an All View. It should also document how the user navigates through the views using drilldowns, view tabs (third-level navigation), or the Site Map.

Screen Flow. The screen design template lists all views available from each screen and indicates the default view for each screen.

Report Design. Report templates track key information relating to reports. The report template includes the business component, Actuate file used, whether the report is dynamic or static, and any subreports available.

Workflow Policies. Workflow Policy templates gather the key information needed to create workflow rules.

Assignment Rules. Assignment Manager templates gather the key information needed to create assignment rules.