logo
Terms of Use and Privacy | Statement of Purpose
Gather, visualize, and query system knowledge
logo
Terms of Use and Privacy | Statement of Purpose
Gather, visualize, and query system knowledge

<<   <   >   >>

Gather | Schema

Sources and Feedback explains the basic structure of captured knowledge, but the physical schema is quite simple, and is stored on a filesystem as folders and files. The schema is extensible by nature, as it is an open-world ontology. One of the advantages of constraining the model to a tree on a filesystem with symlinks, is that it helps contain the graph so that it isn't unwieldy. Another advantage is that it can be checked in to version control systems like git. Finally, trees are a familiar model.

The Cruft Buster model is flexible enough, even in this constrained fashion, that it can handle deep data flow diagrams. Here is an example of a system that uses data flow as the primary focus, rendered as a diagram, with the mouse pointer hovering to show the detail of the data flow between process 1 and Mail Room Staff:

Here is an example of a subset of that same information stored on the filesystem:

The overall logic of the schema is that items needed to generate a visualization of a level are stored at that level on the filesystem. Live rendering is a requirement for easy collaboration on a living document, and the schema facilitates this.

The idea of categories is to organize documentation for the handbook, which is arranged around the primary focus. This takes some getting used to, as the terms change, but it allows parallel development of a written handbook and a model of the primary focus at the same time.

Here is a more detailed schema with mappings to an example filesystem implementation:

schema