Business Rules Document Development
Business Rules Document Development is a service that TIM Consulting provides after the completion of the BRDP Workshops. The outcome of this is an S1000D data module, using the BRDocs Schema, that identifies each decision that has been made and the details around the decision. This data module is issued to the project and can be stored in the Common Source DataBase (CSDB). When decisions are updated, this document should be updated by the project.
The data module formalises the decisions for the project and directly relates to the BREX data module. Any updates to the BRDocs data module also means that the BREX data module may also require updates.
BREX Development
BREX Development is a service that TIM Consulting provides after the completion of the BRDP Workshops. The BREX data module documents the decisions that can be programmatically verified by software.
TIM Consulting have pre-developed BREX and Business Rules Document for each Schema that can be used to update the decisions based on what the project has decided.
Business Rules are an integral aspect of an S1000D project. The S1000D Specification identifies a range of decisions, Business Rules Decision Points (BRDPs), that the project should consider for the project implementation.
The Business Rules development provides two outcomes:
- Guidance for project participants (Technical Authors, Project Managers, Engineers, Commerical, Customers)
- Validation file that software uses to verify content is compliant to the decisions
The Business Rules document is a guidance document that is used as the project style guide that the Technical Authors can use to ensure the content is consistent. Technical Authors refer to the style guide during the authoring of content. Errors of structure can still occur. The validation file, called the Business Rules EXchange (BREX), can be used by the Authoring software to programmatically verify that the content is valid to the decisions that have been made. This same document is also used to assist in defining the deliverables for a project, highlighting the methods of data exchange and supports many commerical decisions that are made and agreed.
The TIM Consulting teams experience provides guidance on the development of Business Rules for S1000D. To ensure that projects have the right Business Rules, TIM Consulting facilitates workshops that guide the project through the decisions that have been identified. The workshops that we run are broken into two levels:
- Management Level business rules definition workshop
- Author specific workshop
The Management level business rules workshop are decisions that the management team of the Technical Publication project must decide. Depending on the decisions that are made in this workshop, they will have a direct effect to the Author specific decisions. Many projects will make the decisions for the higher level workshop and document these in a format that the project can use.
The Author specific decisions are decisions that relate to the optional elements and attributes for each Schema. The attendees of this workshop should include technical authors who understand the S1000D elements and attributes. The optional elements and attributes, in many projects, are not clearly defined. This means that individual authors may use different elements and attributes, therefore there is inconsistency in the content. Alternatively, the authors make the decisions of which elements and/or attributes are to be used and, as a team, will implement. The benefit of this is the project may have consistency but has no methods available to verify the consistency. Conducting the Author specific workshop will mean that the project has decisions for all structure and this ensures consistency of data.
On the completion of the workshops, the project will have made decisions on the implementation of S1000D for the project. Each decision that is made is recorded.
There are two ways that BRDPs can be analysed and defined:
- Use the 10 categories defined in the Specification
- use the BRDP Groups concept
The categories method identifies BRDPs in multiple categories. The categories are a list of topics and represent the subject matters address by the business rules.
The BRDPs Groups concept organises the BRDPs into contextual groups where the BRDPs occur only once. The groups concept is not the same as the categories. For the workshop we use the BRDP Groups concept. This allows us to easily identify each BRDP, make the decision and move to the next group.
TIM Consulting documents each decision that is made in the workshops and issue these to the project at the completion. Once the workshops have been completed, the following documents should be prepared:
- Business Rules Document
- Business Rules EXchange (BREX) data module
Training Calendar
TIM Consulting offer training courses for S1000D Theory and Authoring and ASD STE100.
The next training session available is:
- Februray 2025 - held in Melbourne
- March 2025 - held in Brisbane or Melbourne
- May 2025 - held in Brisbane
This information will be updated as additional courses are made available.
For TIM Consulting Publicly Scheduled Courses, the following extra conditions apply:
- TIM Consulting reserves the right to cancel the course if the minimum number of 6 students are not met 7 days prior to the scheduled start date of the course.
- If a scheduled course is cancelled, customers will be given the opportunity to attend the next scheduled course or discuss customised training options.
Contact TIM Consulting to discuss your requirements.
ASD STE100
English is the international language of science, technology, and human relations. It is also the language of the aerospace and defence industries.
ASD STE100 is a controlled language that is used to ensure that documentation written in ASD STE100 is understood by all readers, including readers that are non-native English readers.
ASD STE100 is used in technical publications, user manuals, and other documentation that must be clear and short. It is related to industry standards and specifications such as S1000D and ATA iSpec200.
The primary objective of ASD STE100 is to create simplified text for the readers. ASD STE100 is a controlled language, not a simplified version of English.
For authors to write correctly in ASD STE100 they must have a good command of the English language and a good knowledge of the subject that the author is writing about. Authors who want to write proficiently and correctly in STE must have only one point of reference: the specification itself.
Some advantages of writing in ASD STE100 are:
- Clear text. ASD STE100 is written to ensure that documentation is easy to understand.
- Decreased translation work. ASD STE100 is easier to translate, which uses less translation time.
This course is recommended for any authors that must implement ASD STE100 in their technical documentation. The course teaches the ASD STE100 rules necessary to implement ASD STE100. This is a "hands on" course with many practice exercises.
TIM Consulting runs regular training sessions and lists these sessions on the Calendar.
Contact TIM Consulting to discuss your requirements.
S-Series
S-Series
S-Series is aimed to establish and adopt a coherent set of IPS Specifications to accomplish:
- Common understanding of IPS and the global processess that integrate all necessary elements and resources
- Optimise the life cycle cost and performance of the Product and its support system
- Respond to initial and changing requirements to optimise processes, improve data quality and remove unnecessary costs
- Collaboration between customers and industry using a simplification of electronic informaiton exchange
S1000D
S1000D is the international specification for technical publications using a common source database. S1000D covers the planning and management, production, exchange, distribution and use of technical documentation that supports the life cycle of a Product. The Technical Publication Team must work with the Engineering Team for the development of the technical publications.
To understand S1000D, TIM Consulting have developed training that provides an introduction based on the roles in the Technical Publication Team. The roles that our training is available for is:
- Practitioners - team members who implement S1000D in the project
- Managers - team members who manage the develoment of content in the project
- Authors - team members who create the content for the project
The training the TIM Consulting offers is:
S2000M
ASD S2000M defines the processes, procedures and provides the information for data exchange to be used for material management throughout the life cycle of a product.
S3000L
ASD S3000L establishes a global standard for Logistic Support Analysis (LSA).
S4000P
ASD S4000P enables projects to design and maintain the support of complex technical product5s, as part of an integrated engineering effort.
S5000F
S5000F describes the basic in-service feedback process, as well as the activites to be performed during the in-service phase and the information that these activities require for their proper execution. The data is fed back is directly related to activities and their need is evidenced if such activities have to be carried out.
S6000T
S6000T defines the process for performing a Training Needs Analysis (TNA), which includes the definition of training requirements, the identification of learning objectives, and the development of a training curriculum. The specification also outlines the data model for information exchange with other S-Series specification, ensuring interoperability across different systems.
TIM Consulting runs regular training sessions and lists these sessions on the Calendar.
Contact TIM Consulting to discuss your requirements.
More Articles …
Page 1 of 2