Editing Scope and applicability

<span id="scope-and-applicability-document"></span>
= Scope and Applicability Document =

{|
!width="23%"| Field
!width="76%"| Value
|-
| Document ID
| PGCBL-SAD-001
|-
| Document Type
| Scope and Applicability Document
|-
| System
| pgcobol — Prime Numbers Application v1.0
|-
| Version
| 1.0
|-
| Status
| Approved
|-
| Owner
| Lead Developer
|-
| Author
| [reverse-engineered from source artifacts]
|-
| Created
| 2026-03-17
|-
| Last modified
| 2026-03-17
|-
| Classification
| Internal
|}

<span id="version-history"></span>
== Version History ==

{|
!width="13%"| Version
!width="18%"| Date
!width="13%"| Author
!width="15%"| Status
!width="38%"| Change Summary
|-
| 0.1
| 2026-03-17
| —
| Draft
| Initial reverse-eng draft
|-
| 1.0
| 2026-03-17
| —
| Approved
| Baselined
|}


-----

<span id="table-of-contents"></span>
== Table of Contents ==

# [[#1-purpose|Purpose]]
# [[#2-system-scope|System Scope]]
# [[#3-document-set-scope|Document Set Scope]]
# [[#4-audience|Audience]]
# [[#5-related-documents|Related Documents]]
# [[#6-open-issues|Open Issues]]


-----

<span id="purpose"></span>
== 1. Purpose ==

This document defines what is and is not covered by the pgcobol specification set. It exists to prevent readers from applying any single document outside its intended context, and to provide a navigational entry point to the full document set.


-----

<span id="system-scope"></span>
== 2. System Scope ==

<span id="what-the-system-is"></span>
=== 2.1 What the system is ===

pgcobol is a three-tier batch COBOL application that:

* Generates prime numbers by trial division and stores them in a PostgreSQL database.
* Reads stored primes from the database and produces a formatted line-printer report.

It runs as a command-line batch job on Linux. There is no interactive interface.

<span id="system-boundary"></span>
=== 2.2 System boundary ===

'''Inside scope:'''

* The four COBOL programs: <code>primesmain</code>, <code>primesgen</code>, <code>primes</code>, <code>primesui</code>.
* The five copybooks that define the inter-tier interfaces.
* The PostgreSQL schema <code>primes</code> and its objects.
* The output file <code>primes.prt</code>.
* The console log output.

'''Outside scope:'''

* The GnuCOBOL compiler and GixSQL pre-processor (third-party tools, not modified).
* The PostgreSQL server installation and administration.
* The operating system, file system, and network infrastructure.
* Any job scheduler or wrapper scripts.
* Any downstream processing of <code>primes.prt</code>.

<span id="system-version-covered"></span>
=== 2.3 System version covered ===

This document set describes pgcobol as found in source artifacts dated November–December 2025, compiled under GnuCOBOL 4.0-early-dev.

<span id="what-is-explicitly-not-covered"></span>
=== 2.4 What is explicitly not covered ===

{|
!width="50%"| Excluded topic
!width="50%"| Reason
|-
| Prime numbers beyond 999,999,999
| Hard-coded upper bound in the source
|-
| Even primes (2)
| The algorithm tests odd candidates only; prime 2 is a known seeding gap
|-
| Interactive or web interfaces
| Not implemented
|-
| Concurrent execution
| Single-process batch design; no concurrency controls present
|-
| Encryption or secure credential storage
| Not implemented in this version
|-
| High-availability or disaster recovery
| Not in scope for this version
|}


-----

<span id="document-set-scope"></span>
== 3. Document Set Scope ==

<span id="documents-in-this-set"></span>
=== 3.1 Documents in this set ===

{|
!width="26%"| Document ID
!width="9%"| Type
!width="50%"| Title
!width="12%"| Covers
|-
| PGCBL-SAD-001
| SAD
| Scope and Applicability
| Navigation and scope
|-
| PGCBL-BRD-001
| BRD
| Business Requirements
| What the system must do
|-
| PGCBL-NFR-001
| NFR
| Non-Functional Requirements
| Quality attributes
|-
| PGCBL-TSD-001
| TSD
| Technical Specification
| Architecture and pseudocode
|-
| PGCBL-DDD-001
| DDD
| Data Dictionary
| All fields and structures
|-
| PGCBL-FLD-001
| FLD
| Flow Diagrams
| Mermaid process diagrams
|-
| PGCBL-PLG-001
| PLG
| Program Logic Guide
| Step-by-step paragraph logic
|-
| PGCBL-BRG-001
| BRG
| Business Rules Guide
| Rules, calculations, validations
|-
| PGCBL-IOB-001
| IOB
| I/O Behaviour
| File, console, DB I/O
|-
| PGCBL-CFD-001
| CFD
| Control Flow Document
| PERFORM/CALL trees
|-
| PGCBL-ADD-001
| ADD
| Architecture Decision Records
| Design decisions and rationale
|-
| PGCBL-TTM-001
| TTM
| Test Traceability Matrix
| Requirements → design → tests
|-
| PGCBL-NCS-001
| NCS
| Naming and Coding Standard
| COBOL conventions
|-
| STD-DOC-001
| STD
| Document Engineering Standard
| This document set’s scaffolding
|}

<span id="how-to-use-this-set"></span>
=== 3.2 How to use this set ===

{|
! I want to…
! Start with…
|-
| Understand what the system must do
| PGCBL-BRD-001
|-
| Understand the overall architecture
| PGCBL-TSD-001 §1–2
|-
| Look up a specific data field
| PGCBL-DDD-001
|-
| Understand how a program works step-by-step
| PGCBL-PLG-001
|-
| Understand why a design decision was made
| PGCBL-ADD-001
|-
| Check what tests cover a requirement
| PGCBL-TTM-001
|-
| Write new COBOL code to the same standards
| PGCBL-NCS-001
|}


-----

<span id="audience"></span>
== 4. Audience ==

{|
!width="33%"| Audience
!width="33%"| Assumed knowledge
!width="33%"| Documents most relevant
|-
| COBOL developer
| COBOL syntax, batch processing
| TSD, PLG, CFD, NCS
|-
| Database developer
| SQL, PostgreSQL
| TSD §5, DDD §12, IOB §3
|-
| Business analyst
| None technical required
| BRD, BRG
|-
| QA engineer
| Testing concepts
| TTM, BRD, BRG
|-
| Architect / reviewer
| Systems design
| TSD, ADD, NFR
|-
| New team member
| None
| SAD (start here), then BRD
|}


-----

<span id="related-documents"></span>
== 5. Related Documents ==

{|
!width="27%"| Document ID
!width="49%"| Title
!width="22%"| Relationship
|-
| STD-DOC-001
| Document Engineering Standard
| Governs the format of all documents in this set
|}


-----

<span id="open-issues"></span>
== 6. Open Issues ==

{|
!width="8%"| ID
!width="60%"| Issue
!width="8%"| Owner
!width="13%"| Target
!width="9%"| Status
|-
| OI-01
| System version identifier not present in source; version inferred from compiler listing date
| Lead Dev
| —
| Open
|}
<hr/>
Terug naar: [[Design standards]]