ArchDoc

The ArchDoc schema is the root-level schema of an ArchDoc Specification file.

Specification

Property	Type	Required	Description
archdoc	string	✅	The ArchDoc Specification version of the document.
users	Map<string,User>	✅	An object that defines the users of your software system. Each key is the short name of a type of user that interacts with your system.
components	Map<string,Component>	✅	An object that defines the components of your software system. Each key is the short name of a type of component that powers your system.

Example

archdoc: 1.0.0
users:
    user:
        ...
    admin:
        ...

components:
    ui:
        ...
    api:
        ...