Formatting Requirements on Gitbook

In order for the testing and compliance website to be able to accurately display the requirements and KDFs for a building block, it is critical that each of these sections have the correct formatting in GitBook. Please follow the guidance below for each section of the Building Block specification.

Building Block Section:

Key Digital Functionalities (Section 4)

• Prefix: Use a prefix 4. for key digital functionalities sections.

• Section Title Example: 4. Key Digital Functionalities.

• Header Types: All types of headers can be used, such as Heading 1, Heading 2, Heading 3, etc., depending on the depth and hierarchy required.

Cross-Cutting Requirements

• Prefix: Use a prefix 5. for cross-cutting requirements sections.

• Section Title Example: 5. Cross-Cutting Requirements.

• Header Types:

  • Heading 1: For the main section title, e.g., 5. Cross-Cutting Requirements.

  • Heading 2: For subsections within the cross-cutting requirements, e.g., 5.1 Data Security.

  • Heading 3: For detailed subpoints under subsections, e.g., 5.1.1 Encryption Standards.

Functional Requirements

• Prefix: Use a prefix 6. for functional requirements sections.

• Section Title Example: 6. Functional Requirements.

• Header Types:

  • Heading 1: For the main section title, e.g., 6. Functional Requirements.

  • Heading 2: For subsections within the functional requirements, e.g., 6.1 User Authentication.

Requirement Descriptions:

• Each requirement must be clearly stated and end with one of the following status markers:

  • (REQUIRED)

  • (RECOMMENDED)

  • (OPTIONAL)

• The status marker should be at the end of the requirement description.

• Formatting and Clarity:

  • Use clear and concise language for each requirement.

  • Organize related requirements into bullet points or numbered lists for better readability.

  • Ensure that each requirement is self-contained and does not rely on context outside its section.

Example Structure for Requirements

4. Key Digital Functionalities

5. Cross-Cutting Requirements (OPTIONAL)

• All data must be encrypted in transit and at rest. System performance should be optimized for scalability. The system may provide APIs for third-party integrations.

6. Functional Requirements