Technical Elements Documentation
    Preparing search index...

    Interface ProcessDocumentation

    Interface representing documentation of the process used in the systems analysis.

    SY-C1

    interface ProcessDocumentation {
        basicEventsDocumentation?: Record<
            string,
            {
                cutsetReference?: string;
                description: string;
                moduleReference?: string;
                system: systems_analysis.SystemReference;
            },
        >;
        componentsFailureModesDocumentation?: Record<
            systems_analysis.SystemReference,
            {
                excludedComponents: string[];
                excludedFailureModes: string[];
                includedComponents: string[];
                includedFailureModes: string[];
                justificationForExclusion: string;
                justificationForFailureModeExclusion: string;
            },
        >;
        dependencySearchDocumentation?: {
            dependencyTableReferences: string[];
            methodology: string;
        };
        designInformation?: BaseDesignInformation[];
        digitalICDocumentation?: Record<
            systems_analysis.SystemReference,
            {
                description: string;
                modelingApproach: string;
                specialConsiderations?: string;
            },
        >;
        equipmentOperabilityDocumentation?: Record<
            string,
            {
                calculationReferences?: string[];
                component: string;
                considerations: string;
                system: systems_analysis.SystemReference;
            },
        >;
        evaluationResultsDocumentation?: Record<
            systems_analysis.SystemReference,
            { otherResults: Record<string, string>; topEventProbability: number },
        >;
        humanActionsDocumentation?: Record<
            systems_analysis.HumanActionReference,
            { description: string; system: systems_analysis.SystemReference },
        >;
        informationSourcesDocumentation?: {
            drawings: string[];
            interviews: string[];
            otherSources: string[];
            procedures: string[];
        };
        inputsDescription?: string;
        logicLoopResolutionsDocumentation?: Record<
            string,
            {
                loopDescription: string;
                resolution: string;
                system: systems_analysis.SystemReference;
            },
        >;
        methodsDescription?: string;
        modelingAssumptionsDocumentation?: Record<
            systems_analysis.SystemReference,
            string[],
        >;
        modularizationDocumentation?: {
            description: string;
            systems: systems_analysis.SystemReference[];
        };
        nomenclatureDocumentation?: Record<string, string>;
        operationalHistoryDocumentation?: Record<
            systems_analysis.SystemReference,
            string[],
        >;
        passiveSystemsDocumentation?: Record<
            systems_analysis.SystemReference,
            { description: string; uncertaintyEvaluation: string },
        >;
        processDescription: string;
        requirementReferences?: { implementation: string; requirementId: string }[];
        resultsDescription?: string;
        sensitivityStudiesDocumentation?: Record<
            systems_analysis.SystemReference,
            { results: string; studyDescription: string }[],
        >;
        spatialInformationDocumentation?: Record<
            string,
            {
                components: string[];
                hazards: string[];
                location: string;
                systems: systems_analysis.SystemReference[];
            },
        >;
        successCriteriaDocumentation?: Record<
            systems_analysis.SystemReference,
            { criteria: string; relationshipToEventSequences: string },
        >;
        supportingDocumentationReferences?: string[];
        systemBoundaryDocumentation?: Record<
            systems_analysis.SystemReference,
            string,
        >;
        systemFunctionDocumentation?: Record<
            systems_analysis.SystemReference,
            string,
        >;
        systemSchematicReferences?: Record<
            systems_analysis.SystemReference,
            { description: string; reference: string },
        >;
        testMaintenanceProceduresDocumentation?: Record<
            systems_analysis.SystemReference,
            string[],
        >;
    }

    Hierarchy (View Summary)

    Index

    Properties

    basicEventsDocumentation? componentsFailureModesDocumentation? dependencySearchDocumentation? designInformation? digitalICDocumentation? equipmentOperabilityDocumentation? evaluationResultsDocumentation? humanActionsDocumentation? informationSourcesDocumentation? inputsDescription? logicLoopResolutionsDocumentation? methodsDescription? modelingAssumptionsDocumentation? modularizationDocumentation? nomenclatureDocumentation? operationalHistoryDocumentation? passiveSystemsDocumentation? processDescription requirementReferences? resultsDescription? sensitivityStudiesDocumentation? spatialInformationDocumentation? successCriteriaDocumentation? supportingDocumentationReferences? systemBoundaryDocumentation? systemFunctionDocumentation? systemSchematicReferences? testMaintenanceProceduresDocumentation?

    Properties

    basicEventsDocumentation?: Record<
        string,
        {
            cutsetReference?: string;
            description: string;
            moduleReference?: string;
            system: systems_analysis.SystemReference;
        },
    >

    Documentation of basic events traceability.

    SY-C1(r)

    componentsFailureModesDocumentation?: Record<
        systems_analysis.SystemReference,
        {
            excludedComponents: string[];
            excludedFailureModes: string[];
            includedComponents: string[];
            includedFailureModes: string[];
            justificationForExclusion: string;
            justificationForFailureModeExclusion: string;
        },
    >

    Documentation of components and failure modes included/excluded.

    SY-C1(l)

    dependencySearchDocumentation?: {
        dependencyTableReferences: string[];
        methodology: string;
    }

    Documentation of system dependencies and search methodology.

    SY-C1(i)

    designInformation?: BaseDesignInformation[]

    Design information sources used in the analysis

    digitalICDocumentation?: Record<
        systems_analysis.SystemReference,
        {
            description: string;
            modelingApproach: string;
            specialConsiderations?: string;
        },
    >

    Documentation of digital I&C systems.

    SY-C1(t)

    equipmentOperabilityDocumentation?: Record<
        string,
        {
            calculationReferences?: string[];
            component: string;
            considerations: string;
            system: systems_analysis.SystemReference;
        },
    >

    Documentation of equipment operability considerations.

    SY-C1(d)

    evaluationResultsDocumentation?: Record<
        systems_analysis.SystemReference,
        { otherResults: Record<string, string>; topEventProbability: number },
    >

    Documentation of system model evaluation results.

    SY-C1(o)

    humanActionsDocumentation?: Record<
        systems_analysis.HumanActionReference,
        { description: string; system: systems_analysis.SystemReference },
    >

    Documentation of human actions for system operation.

    SY-C1(g)

    informationSourcesDocumentation?: {
        drawings: string[];
        interviews: string[];
        otherSources: string[];
        procedures: string[];
    }

    Documentation of information sources.

    SY-C1(q)

    inputsDescription?: string

    Description of inputs used in the analysis

    logicLoopResolutionsDocumentation?: Record<
        string,
        {
            loopDescription: string;
            resolution: string;
            system: systems_analysis.SystemReference;
        },
    >

    Documentation of logic loop resolutions.

    SY-C1(n)

    methodsDescription?: string

    Description of methods applied in the analysis

    modelingAssumptionsDocumentation?: Record<
        systems_analysis.SystemReference,
        string[],
    >

    Documentation of modeling assumptions.

    SY-C1(k)

    modularizationDocumentation?: {
        description: string;
        systems: systems_analysis.SystemReference[];
    }

    Documentation of modularization process.

    SY-C1(m)

    nomenclatureDocumentation?: Record<string, string>

    Documentation of nomenclature used in system models.

    SY-C1(s)

    operationalHistoryDocumentation?: Record<
        systems_analysis.SystemReference,
        string[],
    >

    Documentation of operational history.

    SY-C1(e)

    passiveSystemsDocumentation?: Record<
        systems_analysis.SystemReference,
        { description: string; uncertaintyEvaluation: string },
    >

    Documentation of passive systems.

    SY-C1(u)

    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

    sensitivityStudiesDocumentation?: Record<
        systems_analysis.SystemReference,
        { results: string; studyDescription: string }[],
    >

    Documentation of sensitivity studies results.

    SY-C1(p)

    spatialInformationDocumentation?: Record<
        string,
        {
            components: string[];
            hazards: string[];
            location: string;
            systems: systems_analysis.SystemReference[];
        },
    >

    Documentation of spatial information and hazards.

    SY-C1(j)

    successCriteriaDocumentation?: Record<
        systems_analysis.SystemReference,
        { criteria: string; relationshipToEventSequences: string },
    >

    Documentation of success criteria relationship to event sequences.

    SY-C1(f)

    supportingDocumentationReferences?: string[]

    References to supporting documentation

    systemBoundaryDocumentation?: Record<systems_analysis.SystemReference, string>

    Documentation of system boundaries.

    SY-C1(b)

    systemFunctionDocumentation?: Record<systems_analysis.SystemReference, string>

    Documentation of system functions and operations.

    SY-C1(a)

    systemSchematicReferences?: Record<
        systems_analysis.SystemReference,
        { description: string; reference: string },
    >

    Documentation of system schematics.

    SY-C1(c)

    testMaintenanceProceduresDocumentation?: Record<
        systems_analysis.SystemReference,
        string[],
    >

    Documentation of test and maintenance procedures.

    SY-C1(h)

    Settings

    Member Visibility

    On This Page

    Properties