Rule Maker RFC » History » Version 5
Calvin Hutcheon, 05/09/2022 11:22 PM
| 1 | 1 | Calvin Hutcheon | # Rule Maker RFC |
|---|---|---|---|
| 2 | |||
| 3 | 2 | Calvin Hutcheon | ## Description |
| 4 | |||
| 5 | There's a need for a distributed, general-purpose method that enables any person to author, publish, discover, fetch, scrutinize, prioritize and optionally automate rules on digital networks at scale and with speed. The Xalgorithms Foundation has created a general purpose free/libre/open method called [DWDS](https://gitlab.com/xalgorithms-alliance/dwds-documents/-/blob/master/current/DBA-Thesis_JPotvin_UQuebec-UQO.pdf). Rule Maker is an interface that enables users to construct rules in a way that is consistent with the Data with Direction specification. |
||
| 6 | |||
| 7 | Rule Maker adopts a philosophy of iterative development... |
||
| 8 | |||
| 9 | Given the emergent nature of the interface, Rule Maker is being developed using a methodology of continuous testing |
||
| 10 | |||
| 11 | RM v0.4 is a webapp built in Svelte |
||
| 12 | |||
| 13 | |||
| 14 | ## Features |
||
| 15 | |||
| 16 | Rule authoring is a complex process comprised of a number of activities. However, only some of these must be supported by RMv4. This diagram shows what is supported in the application and what takes place outside. |
||
| 17 | |||
| 18 | 5 | Calvin Hutcheon |  |
| 19 | 1 | Calvin Hutcheon | |
| 20 | 3 | Calvin Hutcheon | [figma link](https://www.figma.com/file/Xz37GPQS5Zw5CRf1ljobHM/RM-Activity-Map?node-id=0%3A1) |
| 21 | |||
| 22 | 1 | Calvin Hutcheon | This diagram defines all the actions that a user would need to accomplish in rule maker. |
| 23 | |||
| 24 | 3 | Calvin Hutcheon |  |
| 25 | |||
| 26 | [figma link](https://www.figma.com/file/r2fxTOD3VGA94AHlBUZTKz/DWDS-Rule-Maker-Action-Map-v0.1.0?node-id=0%3A1) |
||
| 27 | 2 | Calvin Hutcheon | |
| 28 | A required actions across the main areas of RM |
||
| 29 | |||
| 30 | - dev |
||
| 31 | - manifest doc enabling dev to define: |
||
| 32 | - path to json doc defining custom metadata fields (aka a [rule template](https://communications.xalgorithms.org/rule-maker/rule-templates/)) |
||
| 33 | - path to css defining custom styling choices |
||
| 34 | |||
| 35 | - application |
||
| 36 | - metadata |
||
| 37 | - display fields as defined by json document |
||
| 38 | - structure user input into well formatted json per DWDS |
||
| 39 | - table editor |
||
| 40 | - display table editor UI |
||
| 41 | - structure user input into well formatted json per DWDS |
||
| 42 | - output |
||
| 43 | - display fields as defined by json document |
||
| 44 | - structure user input into well formatted json per DWDS |
||
| 45 | - publication |
||
| 46 | - download json |
||
| 47 | - publish to RR (??) |
||
| 48 | |||
| 49 | ## Iterative Development |
||
| 50 | |||
| 51 | What's been learned so far? |
||
| 52 | |||
| 53 | ## Developer and User Experience |
-