Arda Platform Technical Documentation
Tip
Navigate to other sections with the options on the top or the navigation pane on the left.
Organization of the Documentation¶
This documentation site has the following sections:
- Specifications: Contains overall specifications and requirements for the platform. Individual modules in the Design Decomposition may have their own specifications which should not be duplicated here but just referenced.
- Design: Contains the description of how the platform is structured and designed to fulfill the requirements in the first section. It is organized based on the different perspectives of system design: Context for the platform, Functional Decomposition, Runtime Structuer, Artifacts, Operation Administration and Maintenance aspects and development or engineering aspects.
- Process: Describes engineering processes that are used in the specification, design and implementation of the platform.
- Technology: Describes specific technologies used and their recommended best practices and standards in the context of Arda’s platform.
- Engineering Craft: Describes the engineering best practices, how-to instructions and excellence standards to be applied in the development of Arda’s platform.
- Notes: Special topics and other notes that don’t fit in one of the previous categories.
- Templates: Templates to be used or to help in the creation of documents in other sections.
- User Documentation: Documentation intended for end users of the platform. This documentation will usually be published in either Coda or HubSpot. This section is intended to provide draft versions and facilitate authoring and review before publication.