/
Specification Proposal Template

Specification Proposal Template

Owned by Ali González
Last updated: Feb 20, 2025
2 min read

Fill out this form to request a Change to an existing specification. See the complete process in context.

New Building Block Proposal

Proposed Name
REQUIRED

[Proposed name for this Building Block]

Proposed Name
REQUIRED

[Proposed name for this Building Block]

Status

Submitted / on review / approved / declined

(For use by the GovSpec Core Team only)

Date Submitted
REQUIRED

[YYYY-MM-DD]

Requestors
REQUIRED

[Name], [Email], [Affiliation]

[Name], [Email], [Affiliation]

[Name], [Email], [Affiliation]

Building Block Type
REQUIRED

[Foundational/Feature/Guidelines/Cross-Cutting]

Building Block Proposal Description
REQUIRED

[Context or justification for the creation of this building block]

[Solution statement that briefly describes this building block]

Interaction with other Building Blocks
OPTIONAL

[Name of building block] - [Name of functionality with which it interacts]

Existing solutions on the market
RECOMMENDED

[Name] - [URL]

Known APIs
RECOMMENDED

[Name] - [URL]

Existing related policies
RECOMMENDED

[Name] - [URL]

Known related standards
OPTIONAL

[Name] - [URL]

Existing Building Block Change proposal

For requesting to change an existing Building Block, consider whether this change requires a Minor or Major version change. The following may be of guidance:

  • Minor version for the specification: Non-breaking changes to existing version by adding new features or extending existing ones.

  • Major version of the specifications: Breaking changes are being proposed. Below is a list of examples of breaking changes, which often go together (changes in the data model require changes in the API):

    1. Semantic understanding of a BB is fundamentally changed by non-compatible Terminology

    2. Key Digital Functionalities are eliminated or split into new ones,

    3. The requirement levels of Cross-Cutting Requirements or Functional Requirements are changed, or new mand-atory requirements are added

    4. Changes in the Data Model are needed which require the elimination or splitting of a existing resource, or the addition of a new required resource is needed.

    5. The Service API model requires the release of a new version

Building Block Impacted
REQUIRED

[Name of BB] - [Version] - [URL]

Building Block Impacted
REQUIRED

[Name of BB] - [Version] - [URL]

Status

Submitted / on review / approved / declined

(For use by the GovSpec Core Team only)

Date Submitted
REQUIRED

[YYYY-MM-DD]

Requestors
REQUIRED

[Name], [Email], [Affiliation]

[Name], [Email], [Affiliation]

[Name], [Email], [Affiliation]

Type of change proposed
REQUIRED

[Minor Version/Major Version]

Change Request details
In case of Major or Minor version request, use this section to broadly describe your proposed changes

Change Proposal Description
REQUIRED

[Context or justification for the change proposal]

[Solution statement that briefly describes the scoped proposed]

Optional Details
The following section is optional, but identifying how you expect these sections to change clarify the extent of the work work that needs to be done to advance this specification to the next version.

Section 3. Terminology
OPTIONAL

[Rough description of changes]

Section 4. Key digital functionalities
OPTIONAL

[Rough description of changes]

Section 5. Cross-Cutting Requirements
OPTIONAL

[Rough description of changes]

Section 6. Functional Requirements
OPTIONAL

[Rough description of changes]

Section 7. Data Structures
OPTIONAL

[Rough description of changes]

Section 8. Service APIs
OPTIONAL

[Rough description of changes]

Section 9. Internal Workflows
OPTIONAL

[Rough description of changes]

Addition of section

OPTIONAL

[Description of section title and its contents]

 

Related content