Design standards: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
|||
| (3 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
= Index of Document Engineering and System Requirements = |
= Index of Document Engineering and System Requirements = |
||
# [[Document Engineering]] |
|||
| ⚫ | |||
- [[Document Versioning|Versioning Rules]] |
|||
| ⚫ | |||
- Major version increments (e.g., 1.0) |
|||
# [[Architecture decision records]] |
|||
- Minor version updates (e.g., 1.1, 1.2) |
|||
| ⚫ | |||
- [[Mandatory Sections in Documents|Mandatory Sections]] |
|||
| ⚫ | |||
- Scope and Applicability |
|||
| ⚫ | |||
- Audience Identification |
|||
| ⚫ | |||
- Related Documents Reference |
|||
- |
== Cross-Document References]] |
||
- Mediawiki Syntax Usage |
|||
- Template Application |
|||
== 2. Scope and Applicability == |
|||
| ⚫ | |||
- [[System Version Identifier|System Version Identifier]] |
|||
- pgcobol — Prime Numbers Application v1.0 |
|||
- [[Document Hierarchy|Document Hierarchy]] |
|||
- Navigation Links Between Documents |
|||
- [[Component Coverage|Component Coverage]] |
|||
- Covered Components: dal-methods, ui-methods, methods |
|||
| ⚫ | |||
- [[Assumption Register|Assumption Register (PGCBL-SAD-002)]] |
|||
- Key Items and Their Types |
|||
- [[Dependency Management|Dependency Handling]] |
|||
- External Systems and Interfaces |
|||
- [[Constraint Handling|Constraints Overview]] |
|||
| ⚫ | |||
- [[Quality Attributes|Using ISO/IEC 25010 Taxonomy]] |
|||
- Categories: Auditability, Compliance, Operability |
|||
- [[Requirement Taxonomy|Taxonomy Details]] |
|||
- Hierarchical breakdown of requirements |
|||
== 5. Architecture Decision Records == |
|||
- [[Design Decisions|Architecture Decisions (ADR-005)]] |
|||
- Option C Implementation Details |
|||
- [[Consequences of Choices|Positive and Negative Outcomes]] |
|||
- Impact Analysis of Design Choices |
|||
- [[Known Issues|Current Issues]] |
|||
- Duplicate copybooks, Versioning Conflicts |
|||
| ⚫ | |||
- [[Test Planning|Matrix Structure]] |
|||
- PGCBL-TTM-001 Template |
|||
- [[Requirements Mapping|Mapping Requirements to Tests]] |
|||
- BRD and NFR Integration |
|||
- [[Status Tracking|Test Case Status]] |
|||
- Draft, In Progress, Completed |
|||
| ⚫ | |||
- [[Source File Conventions|File Naming Rules]] |
|||
- Verb Usage in Copybooks |
|||
- [[Division Structure|Code Division Hierarchy]] |
|||
- Module Organization |
|||
- [[Compliance with Standards|Standards Adherence]] |
|||
- Coding Best Practices |
|||
| ⚫ | |||
- [[Audience and Distribution|Intended Readers]] |
|||
- Business Analysts, QA Engineers |
|||
- [[Related Documents Linkage|Document Relationships]] |
|||
- SAD, NFR, TSD, TTM, ADD |
|||
- [[Assumptions and Dependencies Overview|Key Dependencies]] |
|||
- System Integration Points |
|||
== Cross-Document References == |
|||
; Document ID | Title | Relationship |
; Document ID | Title | Relationship |
||
|---|---|--- |
|---|---|--- |
||
Latest revision as of 15:33, 25 March 2026
Index of Document Engineering and System Requirements[edit]
- Document Engineering
- Scope and applicability
- Assumptions and Dependencies
- Architecture decision records
- Non-Functional Requirements
- Test Traceability Matrix
- Naming and Coding Standards
- 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