Technical Elements Documentation
    Preparing search index...

    Interface BaseProcessDocumentation

    Base interface for process documentation across technical elements. Provides a consistent structure for documenting analysis processes.

    interface BaseProcessDocumentation {
        designInformation?: BaseDesignInformation[];
        inputsDescription?: string;
        methodsDescription?: string;
        processDescription: string;
        requirementReferences?: { implementation: string; requirementId: string }[];
        resultsDescription?: string;
        supportingDocumentationReferences?: string[];
    }

    Hierarchy (View Summary)

    Index

    Properties

    designInformation? inputsDescription? methodsDescription? processDescription requirementReferences? resultsDescription? supportingDocumentationReferences?

    Properties

    designInformation?: BaseDesignInformation[]

    Design information sources used in the analysis

    inputsDescription?: string

    Description of inputs used in the analysis

    methodsDescription?: string

    Description of methods applied in the analysis

    processDescription: string

    Description of the overall process used

    requirementReferences?: { implementation: string; requirementId: string }[]

    Traceability to requirements

    Type declaration

    • implementation: string

      How the requirement is addressed

    • requirementId: string

      Requirement identifier

    resultsDescription?: string

    Description of the results of the analysis

    supportingDocumentationReferences?: string[]

    References to supporting documentation

    Settings

    Member Visibility

    On This Page

    Properties