Design standards: Difference between revisions

From Webhuis wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(6 intermediate revisions by the same user not shown)
Line 1: Line 1:
= Index of Document Engineering and System Requirements =
⚫
# Document Index


⚫
# [[Document Engineering]]
⚫
## Architecture Decision Records (ADR)
# [[Scope and applicability]]
### File: `04_architecture_decision_records.mediawiki`
⚫
# [[Assumptions and Dependencies]]
- **Purpose**: Captures significant design decisions and their consequences.
# [[Architecture decision records]]
- **Format**: Follows the MADR format, a lightweight standard for documenting architectural decisions.
⚫
# [[Non-Functional Requirements]]
- **Contents**:
⚫
# [[Test Traceability Matrix]]
- ADR template
⚫
# [[Naming and Coding Standards]]
- Specific decisions (e.g., Three-Tier Architecture)
⚫
# [[Business Requirement Document]]
⚫
== 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.
⚫
## Test Traceability Matrix (TTM)
### 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

⚫
## Non-Functional Requirements (NFR)
### 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.

⚫
## Business Requirements Document (BRD)
### 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)

⚫
## Naming Coding Standard
### File: `06_naming_coding_standard.mediawiki`
- **Purpose**: Standards for source file conventions.
- **Status**:
- Version: 1.0
- Approved and baselined.

⚫
## Scope and Applicability (SAD)
### File: `02_scope_and_applicability.mediawiki`
- **Purpose**: Defines the document set and its navigation.
- **Related Documents**:
- Links to other documents in the set.

## Technical Specification Document (TSD)
### File: `01_technical_specification.mediawiki`
- **Purpose**: Implements system requirements.
- **Assumptions**: See PGCBL-SAD-002 for full register.

⚫
## Assumptions and Dependencies Register
### File: `08_assumptions_and_dependencies_register.mediawiki`
- **Contents**:
- Key assumptions and dependencies (e.g., A-01, C-01)

## Test Case Catalogue
### File: `05_test_traceability_matrix.mediawiki`
- **Purpose**: Catalogues test cases linked to requirements.
- **Status**: Includes planned tests requiring fixes.

## Out of Scope Items
### File: `07_brd_pgcbl-brd-001.mediawiki`
- **Contents**:
- Exclusions from the system's functionality.

## Open Issues and Defects
### File: `09_open_issues_and_defects.mediawiki`
- **Contents**:
- Known issues (e.g., OI-01, D-01)
- Targets and owners

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

## Revision History
- **Version Control**: Not explicitly detailed in provided context.
<hr/>
<hr/>
Terug naar: [[Cobol and PostgreSQL]]
Terug naar: [[Cobol and PostgreSQL]]

Latest revision as of 15:33, 25 March 2026

Index of Document Engineering and System Requirements[edit]

  1. Document Engineering
  2. Scope and applicability
  3. Assumptions and Dependencies
  4. Architecture decision records
  5. Non-Functional Requirements
  6. Test Traceability Matrix
  7. Naming and Coding Standards
  8. Business Requirement Document

== 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

Retrieved from "https://wiki.webhuis.nl:443/index.php?title=Design_standards&oldid=4755"