Before reading any of the guides in this section, please consider reading the conceptual overview of RIDDL as a prerequisite.
There are four kinds of readers of this documentation based on the intent of the reader. Accordingly, the documentation has a guide for each kind of reader:
For knowledge domain experts who would provide concepts, structure, and event flows to RIDDL authors.
For those who will write RIDDL specifications and must know the language intricacies for full and accurate specifications.
For those who will implement software systems based on RIDDL specifications and the output of RIDDL based tools.
For those who will work on the RIDDL software itself or help others with their use of it.
The following sections define these roles more clearly:
Domain experts (DEs) are subject matter experts (SMEs) in some knowledge or problem domain. They are the authority on the language used to describe both problems and solutions within their domain or field of expertise. These individuals are recognized authorities, and they influence an organization’s product, service or strategic direction.
Authors are the individuals who create system specifications. Such work is greatly aided by using a clear, concise, precise, and intuitive language in which to specify a system. That language is RIDDL. Authors form the bridge between Domain Experts and Implementors.
Implementors are the technical experts who implement the system defined in a RIDDL specification. These people are most often Software, QA, and DevOps Engineers. Of course, throughout implementation they will be supported by the Author(s), Domain Experts, and other related staff. Implementors use the output from the RIDDL tools to aid in their comprehension and coding of a solution that corresponds to the RIDDL system specification or model.
Developers are the technical experts that advance RIDDL’s state of the art. They develop the tooling and documentation that makes up RIDDL. Since RIDDL is an open source project, developers can be affiliated with many organizations, presumably the organizations that derive utility from RIDDL.