Design standards

Index of Document Engineering and System Requirements

1. Document Engineering

- Versioning Rules

  - Major version increments (e.g., 1.0)
  - Minor version updates (e.g., 1.1, 1.2)

- Mandatory Sections

  - Scope and Applicability
  - Audience Identification
  - Related Documents Reference

- Format Standards

  - Mediawiki Syntax Usage
  - Template Application

2. Scope and Applicability

Scope and applicability - System Version Identifier

  - pgcobol — Prime Numbers Application v1.0

- Document Hierarchy

  - Navigation Links Between Documents

- Component Coverage

  - Covered Components: dal-methods, ui-methods, methods

3. Assumptions and Dependencies

- Assumption Register (PGCBL-SAD-002)

  - Key Items and Their Types

- Dependency Handling

  - External Systems and Interfaces

- Constraints Overview

4. Non-Functional Requirements

- Using ISO/IEC 25010 Taxonomy

  - Categories: Auditability, Compliance, Operability

- Taxonomy Details

  - Hierarchical breakdown of requirements

5. Architecture Decision Records

- Architecture Decisions (ADR-005)

  - Option C Implementation Details

- Positive and Negative Outcomes

  - Impact Analysis of Design Choices

- Current Issues

  - Duplicate copybooks, Versioning Conflicts

6. Test Traceability Matrix

- Matrix Structure

  - PGCBL-TTM-001 Template

- Mapping Requirements to Tests

  - BRD and NFR Integration

- Test Case Status

  - Draft, In Progress, Completed

7. Naming and Coding Standards

- File Naming Rules

  - Verb Usage in Copybooks

- Code Division Hierarchy

  - Module Organization

- Standards Adherence

  - Coding Best Practices

8. Business Requirement Document (BRD)

- Intended Readers

  - Business Analysts, QA Engineers

- Document Relationships

  - SAD, NFR, TSD, TTM, ADD

- Key Dependencies

  - System Integration Points

Cross-Document References

Document ID | Title | Relationship

|---|---|--- | PGCBL-SAD-001 | Scope and Applicability | Navigation Guide | PGCBL-NFR-001 | Non-Functional Requirements | Quality Attributes Complement | PGCBL-TSD-001 | Technical Specification | Implementation Details | PGCBL-TTM-001 | Test Traceability Matrix | Test Case Mapping | PGCBL-ADD-001 | Architecture Decision Records | Design Documentation

This index provides a structured overview of the document set, facilitating easy navigation and understanding of the interrelated components.

---

Terug naar: Cobol and PostgreSQL