Design standards: Difference between revisions

From Webhuis wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
# Document Index


```mediawiki
## Architecture Decision Records (ADR)
= Index of Document Engineering and System Requirements =
### 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. Document Engineering ==
## Test Traceability Matrix (TTM)
- [[Document Versioning|Versioning Rules]]
### File: `05_test_traceability_matrix.mediawiki`
- Major version increments (e.g., 1.0)
- **Purpose**: Tracks the relationship between requirements and test cases.
- Minor version updates (e.g., 1.1, 1.2)
- **Contents**:
- [[Mandatory Sections in Documents|Mandatory Sections]]
- TC-NFT-002 — Performance: divider lookup query plan
- Scope and Applicability
- TC-NFT-003 — Reliability: graceful DB failure mid-run
- Audience Identification
- Related Documents Reference
- [[Document Format Standards|Format Standards]]
- Mediawiki Syntax Usage
- Template Application


== 2. Scope and Applicability ==
## Non-Functional Requirements (NFR)
- [[System Version Identifier|System Version Identifier]]
### File: `03_non_functional_requirements.mediawiki`
- pgcobol — Prime Numbers Application v1.0
- **Purpose**: Specifies quality attributes of the system.
- [[Document Hierarchy|Document Hierarchy]]
- **Taxonomy**: Uses ISO/IEC 25010:2011 (SQuaRE) model.
- Navigation Links Between Documents
- **Contents**:
- [[Component Coverage|Component Coverage]]
- Categories: Performance, Reliability, Security, etc.
- Covered Components: dal-methods, ui-methods, methods


== 3. Assumptions and Dependencies ==
## Business Requirements Document (BRD)
- [[Assumption Register|Assumption Register (PGCBL-SAD-002)]]
### File: `07_brd_pgcbl-brd-001.mediawiki`
- Key Items and Their Types
- **Purpose**: Defines business requirements and scope.
- [[Dependency Management|Dependency Handling]]
- **Audience**: Business analysts, QA engineers, stakeholders.
- External Systems and Interfaces
- **Contents**:
- [[Constraint Handling|Constraints Overview]]
- Assumptions and dependencies
- Out of Scope items
- Open issues (e.g., FR-01: generate loop commented out)


== 4. Non-Functional Requirements ==
## Naming Coding Standard
- [[Quality Attributes|Using ISO/IEC 25010 Taxonomy]]
### File: `06_naming_coding_standard.mediawiki`
- Categories: Auditability, Compliance, Operability
- **Purpose**: Standards for source file conventions.
- [[Requirement Taxonomy|Taxonomy Details]]
- **Status**:
- Hierarchical breakdown of requirements
- Version: 1.0
- Approved and baselined.


== 5. Architecture Decision Records ==
## Scope and Applicability (SAD)
- [[Design Decisions|Architecture Decisions (ADR-005)]]
### File: `02_scope_and_applicability.mediawiki`
- Option C Implementation Details
- **Purpose**: Defines the document set and its navigation.
- [[Consequences of Choices|Positive and Negative Outcomes]]
- **Related Documents**:
- Impact Analysis of Design Choices
- Links to other documents in the set.
- [[Known Issues|Current Issues]]
- Duplicate copybooks, Versioning Conflicts


== 6. Test Traceability Matrix ==
## Technical Specification Document (TSD)
- [[Test Planning|Matrix Structure]]
### File: `01_technical_specification.mediawiki`
- PGCBL-TTM-001 Template
- **Purpose**: Implements system requirements.
- [[Requirements Mapping|Mapping Requirements to Tests]]
- **Assumptions**: See PGCBL-SAD-002 for full register.
- BRD and NFR Integration
- [[Status Tracking|Test Case Status]]
- Draft, In Progress, Completed


== 7. Naming and Coding Standards ==
## Assumptions and Dependencies Register
- [[Source File Conventions|File Naming Rules]]
### File: `08_assumptions_and_dependencies_register.mediawiki`
- Verb Usage in Copybooks
- **Contents**:
- [[Division Structure|Code Division Hierarchy]]
- Key assumptions and dependencies (e.g., A-01, C-01)
- Module Organization
- [[Compliance with Standards|Standards Adherence]]
- Coding Best Practices


== 8. Business Requirement Document (BRD) ==
## Test Case Catalogue
- [[Audience and Distribution|Intended Readers]]
### File: `05_test_traceability_matrix.mediawiki`
- Business Analysts, QA Engineers
- **Purpose**: Catalogues test cases linked to requirements.
- [[Related Documents Linkage|Document Relationships]]
- **Status**: Includes planned tests requiring fixes.
- SAD, NFR, TSD, TTM, ADD
- [[Assumptions and Dependencies Overview|Key Dependencies]]
- System Integration Points


== Cross-Document References ==
## Out of Scope Items
; Document ID | Title | Relationship
### File: `07_brd_pgcbl-brd-001.mediawiki`
|---|---|---
- **Contents**:
| PGCBL-SAD-001 | Scope and Applicability | Navigation Guide
- Exclusions from the system's functionality.
| 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.
## 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]]

Revision as of 14:55, 25 March 2026

```mediawiki

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

- 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

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