Software Types

Element types that document technical architecture, implementation and quality artefacts.

Covers:

• Dependency — An external library or package: package, version, dependencyType (runtime/dev/peer/optional), license, purpose.
• Model — A data schema or structured type: modelFormat (typescript/json-schema/sql/protobuf/avro/plain). Typed fields via dai:properties.
• Test — A test case: testType (unit/integration/e2e/acceptance/performance/security), testStatus, testSteps, expectedResult, actualResult.
• Issue — A bug or blocker: issueType (bug/enhancement/blocker/question), severity, status, stepsToReproduce, expectedResult, actualResult, assignee.
• API Endpoint — A REST or GraphQL endpoint: method, path, authType, requestBody, responseBody, statusCode, service (connects to a Service element).
• Service — An external or internal service: baseUrl, version, authType. Provides context for the API Endpoint elements that belong to it.
• Component — A UI or software component: componentType (ui/layout/page/hook/utility/service/library), propsInterface.
• Database — A database or data store: engine (postgresql/mysql/sqlite/mongodb/redis/dynamodb/firestore/other), host, schema, accessPattern.
• Event — A domain event in an event-driven system: producer, consumers, broker (kafka/rabbitmq/aws-sns/aws-sqs/gcp-pubsub/redis-pubsub/custom/none), payloadSchema.