S14-System Architecture Modeling in Obsidian

#systems #obsidian #git

1 Purpose

The purpose of this document is to standardize practices for using the Obsidian note taking program to express a system architecture model.

2 Scope

3 Representing model elements

We have adapted it for use with text (Markdown) files, Git, and the Obsidian notes application.

3.1 File Types

3.2 Document Types

4 Structuring the Obsidian notebook

The notebook represents each system architecture level as an index document and the other documents that describe that level.

Document names are unique.

Documents get numbered.

No files are to be deleted. They must have an underscore "_" added to the front of the file name and have the entry in their index struck through. This ensures that authors do not reuse index numbers.