Verify SRVDD Document Matches Template. (SL021)
Verifies the service SRVDD file follows the provided template.
Description
The service design document(SRVDD) is used to accurately document service architecture and POCs. Service SRVDDs should follow the template provided on the start-documents git repository. When templated sections are missing from the service SRVDD or additional, non-templated sections are added to the service SRVDD, informative violations are returned.
Findings
-
INFO
-
SRVDD file is missing the template headers: from the respective lines:
-
SRVDD file includes the non-templated headers: on the respective lines:
-
SRVDD file is missing the template table columns: from the respective lines:
-
Noncompliant
Non-Templated SRVDD
"Service Name" Service Design Document (SRVDD)
===============================================
... content ...
<!-- Missing Required Header (Service Information) -->
## Purpose
... content ...
## High-level App Categorization
<!-- Missing Required Headers and Table Columns -->
## Security :
<!-- Missing Required Header for Security Services with Mobile OAuth Integration (Mobile OAuth Integration) -->
... content ...
#### Mobile OAuth STS Client Configuration
| <!-- Missing Required Header (Client Setting) --> | Configuration | Setting Description |
|---------------------------------------------------|----------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
... content ...
Mobile OAuth Integration
> SRVDD Template v1.4
<!-- Missing Required Header (Appendix) -->Compliant
Templated SRVDD
"Service Name" Service Design Document (SRVDD)
===============================================
... content ...
# Service Information
... content ...
## Purpose
... content ...
## High-level App Categorization
### Intended Service Availability (APIGW registration - staff / veteran (public))
... content ...
### Data Access / Storage Overview
| **Data Type** | **VAMF/VA Source** | **CRUD Operations** | **DB Type** | **DB Name** | **Data Classification** | **Reason / Requirement** |
... content ...
**DESCRIBE DATA ARCHIVAL STRATEGY:**
... content ...
**DESCRIBE DATA ANALYTICS PLATFORM UTILIZATION:**
... content ...
# Conceptual Design
... content ...
## Conceptual Diagram
... content ...
## Conceptual Persistence Model
... content ...
# Logical Design Perspective
## Logical Interface design
... content ...
## Logical Interactions
|Endpoint|HTTP Action|External System Endpoint (table mapping for databases) | Authorization Type |Description|
... content ...
## Tech Stack :
| **Question** | **YES** | **NO** | **Comment - if answer is no, please explain** |
... content ...
### Major Technologies, Frameworks and Libraries ###
... content ...
| **Name** | **Major Version Planned** | **Backlog item** | **Planned Date to Prod**|
... content ...
## Logical Persistence Model
... content ...
## Security :
... content ...
### Mobile OAuth Integration
... content ...
#### Mobile OAuth STS Client Configuration
| Client Setting | Configuration | Setting Description |
|----------------------------------|----------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
... content ...
# Physical Design Perspective :
## Deployment Environment
... content ...
## Data Dictionary
... content ...
| **Element Name** | **Data Type** | **Relationship** | **Description/DOV List** |
... content ...
# Developer & PM Contact Information :
|**Title** | **Name** | **Point of Contact (VA Email)** | **Phone Number** |
... content ...
> SRVDD Template v1.4
# Appendix