Design standards

1. Document Index

1. 1. Architecture Decision Records (ADR)
      1. File: `04_architecture_decision_records.mediawiki`

- **Purpose**: Captures significant design decisions and their consequences. - **Format**: Follows the MADR format, a lightweight standard for documenting architectural decisions. - **Contents**:

 - ADR template
 - Specific decisions (e.g., Three-Tier Architecture)

1. 1. Test Traceability Matrix (TTM)
      1. File: `05_test_traceability_matrix.mediawiki`

- **Purpose**: Tracks the relationship between requirements and test cases. - **Contents**:

 - TC-NFT-002 — Performance: divider lookup query plan
 - TC-NFT-003 — Reliability: graceful DB failure mid-run

1. 1. Non-Functional Requirements (NFR)
      1. File: `03_non_functional_requirements.mediawiki`

- **Purpose**: Specifies quality attributes of the system. - **Taxonomy**: Uses ISO/IEC 25010:2011 (SQuaRE) model. - **Contents**:

 - Categories: Performance, Reliability, Security, etc.

1. 1. Business Requirements Document (BRD)
      1. File: `07_brd_pgcbl-brd-001.mediawiki`

- **Purpose**: Defines business requirements and scope. - **Audience**: Business analysts, QA engineers, stakeholders. - **Contents**:

 - Assumptions and dependencies
 - Out of Scope items
 - Open issues (e.g., FR-01: generate loop commented out)

1. 1. Naming Coding Standard
      1. File: `06_naming_coding_standard.mediawiki`

- **Purpose**: Standards for source file conventions. - **Status**:

 - Version: 1.0
 - Approved and baselined.

1. 1. Scope and Applicability (SAD)
      1. File: `02_scope_and_applicability.mediawiki`

- **Purpose**: Defines the document set and its navigation. - **Related Documents**:

 - Links to other documents in the set.

1. 1. Technical Specification Document (TSD)
      1. File: `01_technical_specification.mediawiki`

- **Purpose**: Implements system requirements. - **Assumptions**: See PGCBL-SAD-002 for full register.

1. 1. Assumptions and Dependencies Register
      1. File: `08_assumptions_and_dependencies_register.mediawiki`

- **Contents**:

 - Key assumptions and dependencies (e.g., A-01, C-01)

1. 1. Test Case Catalogue
      1. File: `05_test_traceability_matrix.mediawiki`

- **Purpose**: Catalogues test cases linked to requirements. - **Status**: Includes planned tests requiring fixes.

1. 1. Out of Scope Items
      1. File: `07_brd_pgcbl-brd-001.mediawiki`

- **Contents**:

 - Exclusions from the system's functionality.

1. 1. Open Issues and Defects
      1. File: `09_open_issues_and_defects.mediawiki`

- **Contents**:

 - Known issues (e.g., OI-01, D-01)
 - Targets and owners

1. 1. Cross-References

- **Related Documents**: Each document references others in the set, such as SAD, NFR, TSD, ADR, and TTM.

1. 1. Revision History

- **Version Control**: Not explicitly detailed in provided context.

---

Terug naar: Cobol and PostgreSQL