Follow this 8 step path to sharpen your skills in getting down your business
facts in an understandable, well organized and refreshingly useful way.
Scrolls contain all your business lore that has been weighted and found to be worth to be written down for future folk to read.
Technically scrolls are a bunch of files (a file tree), which might be located in the file system, on a ftp or http server, in a tar or jar or zip archive or in a git repository, like github. Sure, you may also read them displayed on a nice website.
Because it can be tedious work to find and decipher whatever your ancestor fellows wrote down on a lengthy lore scroll, the directories in the file tree are marked with magic symbols that reveal their type and thereby their secrets. As it is magic, many of those symbols are invisible.
Specifically, each directory and file has attached meta data, stored either in additional files, stored inside the data files themselves or stored nowhere at all.
Nowhere at all means: there are plenty of reasonable defaults, guessed from names, extensions and file types.
Meta data in additional files: Files named '.meta' contain meta information for their containing directory, files named 'something.meta' refer to a file (or directory) named 'something'. Meta files contain a simple property tree formatted as JSON, XML, YAML, Java Properties or INI-Style.
Meta data in data files internally: Some file formats support to contain meta data in themselves.
The meta data top level entry 'Type' tells us what kind of file we're dealing with in our scroll. The type is described by it's Sigil, i.e. you can summon up all details if you like.
Tales is wisdom told from fellow to fellow.
More precisely, tales are various pieces of text, like stories and documentation. As with all elements of scrolls, these pieces are organised to be easier to retrieve, to discover their purpose. Also, they are simple to write and delighting to read.
To achieve the first, they are organised as Doclets, which are pieces of text marked with metadata to be classifyable as Doclets and annotated with CommonMark or MarkDown for layouting.
Yet, silence is golden. I.e., while it might be tempting to fill scrolls with lengthy talk, it is far more wiser to use the other elements to form a balanced lorework and augment it just as needed with appropriate tales, to complete it and make it smooth.
A sigil is a name or sign that gives you magic power over something. By using Sigils you can summon these things to serve you.
Technically Sigils are unique identifiers that look like URLs. They are made up of socalled "reverse domain names", as well as of the kind of thing you are referring to.
We use reverse domain names, because you can control them. E.g., if you are the owner of the domain www.example.com, then your reverse domain names begin with com.example.www, and your free to append to this name whatever you like. We prefer this reverse form since people using latin symbols usually write from left to right.
We us an additional type since you might wish to distinguish apples from oranges, so you may want to call your apple com.example.www.joe and your orange as well (at this point, just believe us you might want to this).
Maps guide you through dark valleys and stormy mountains, to keep you on track while solving your quest.
Technically Maps are, more precisely, Topological Maps. They graphically describe the logical essence of some connected structure by displaying it's pieces and their relations for certain purposes at hand.
Like Tales, Maps can be more freestyle oriented artful paintings formatted in SVG, mostly intended for illustration purposes. SVG Maps can also be marked up with additional metadata to describe the undelying data structure precisely, which in turn can be extracted then.
Alternatively, Maps can be described more bare bone by just providing their data structure, marked up with hints on how to render them in all their beauty. These hints typically just consist of the coordinates of the items, based on which and with additionally provided external map style sheets in MSS format nice diagrams can be rendered.
A simple but effective alternative to providing coordinates explicitly is the MDDL (to be defined) which is already used and available in the variant of WIDL (wiki diagram language). It allows specifying the placement of elements by putting them in a coarse ASCII map.
Drawings reveal the inner secrets of constructions like ancient buildings or mysterious machines.
More precisely: Architectural Drawings.
A Thesaurus reveals the inner secret fabrics of a certain realm of existence by explicating all it's gory details.
Technically, a Thesaurus contains the domain knowledge, represented as a more or less complex data structure with precisely defined elements (typed) and their relations. It usually is a projection of some existing or desirable domain or entity by means of abstraction.
Even more technically, Thesauri are ontological or system models desribed in OCP format. OCP allows for simple formatting based on JSON, XML, YAML, MarkDown, SpreadSheets, Diagrams and OORLs, but is flexible to cover arbitrary strcutures and allows to combine different views onto the same subject without interfering with each other.
Recipes teach the novice how to follow the path to achievement, and preserve the essence of the wisdom of the elder.
Technically, Recipes are workflows that describe how to do things. Recipes in lore scrolls are lightweight, enjoyable and efficient descriptions of procedures. They are healthy and token-free.
Specifically, Recipes are based on UBPML concepts and either described as slightly formalised marked up texts or more data structure like, as it goes with Maps.
Spells are the fun part: colorful flashes, smoking explosions, flying rocks in moonlit forests with glowing-eyed owls on fir trees.
Technically, spells are the technical part of IT. All you love if you are from within IT, and all you hate if you're not.
As with all kinds of magic, Spells can do cause harm and should therefore be used only by the experienced and wise. But, on the other hand, and as matter of course, Spells can do all the fantastic things your businees needs so desparately.
Spells are formatted as... - well, as if it be so easy.