Untitled Project
OpenBumpy - Documentation Blueprint & Standards Manual

1. Project Overview & Philosophy

2. The Documentation Suite Lifecycle (The Hierarchy)

2.1. Document Descriptions & Roles

2.2. Nomenclature & UID Prefixes Standard

2.3. Vertical Mapping Framework

3. Specification Writing Standards

3.1. Requirement Verification Methods

3.2. Requirement Priority Definitions

3.3. Quality Rules & Specifications

OB-SQMP-KEYW

3.3.1. RFC 2119 Keyword Usage

OB-SQMP-KEYW
RULE-OB-001
3.3.1.1. Compliance Keyword Capitalization RULE-OB-001

The author MUST write all compliance keywords (MUST, MUST NOT, SHOULD, SHOULD NOT, MAY) in uppercase letters.

RULE-OB-002
3.3.1.2. Prohibition of Vague Language RULE-OB-002

The author MUST NOT use ambiguous terms such as generally, fast, ideally, or user-friendly within a specification description.

RULE-OB-003
3.3.1.3. Justification for Deviations RULE-OB-003

The implementation team SHOULD document a technical justification whenever a SHOULD or SHOULD NOT requirement is bypassed.

OB-SQMP-STRU

3.3.2. Sentence Structure and Architecture

OB-SQMP-STRU
RULE-OB-004
3.3.2.1. Single Requirement Principle RULE-OB-004

Each specification description MUST contain exactly one unique requirement.

RULE-OB-005
3.3.2.2. Active Voice Enforcement RULE-OB-005

The author MUST write specification descriptions using the active voice.

RULE-OB-006
3.3.2.3. Sentence Component Anatomy RULE-OB-006

The author MUST structure every specification sentence using the sequence: [Subject] + [Keyword] + [Active Verb] + [Measurable Target or Condition].

RULE-OB-007
3.3.2.4. Sentence Length Limit RULE-OB-007

The length of a specification description sentence SHOULD NOT exceed 15 words.

OB-SQMP-METR

3.3.3. Metrics and Quantifiable Data

OB-SQMP-METR
RULE-OB-008
3.3.3.1. Measurable Criteria Requirement RULE-OB-008

Every performance or physical criterion MUST include a quantifiable, testable numerical value.

RULE-OB-009
3.3.3.2. Standard Unit System RULE-OB-009

The author MUST express all physical units of measurement using the International System of Units (SI).

RULE-OB-010
3.3.3.3. Mathematical Tolerance Notation RULE-OB-010

The author SHOULD use standard mathematical symbols (e.g., , , ±) to define acceptable boundary limits and tolerances.

OB-SQMP-IDEN

3.3.4. Identification and Labeling Rules

OB-SQMP-IDEN
RULE-OB-011
3.3.4.1. Global Identification Regex Constraints RULE-OB-011

The author MUST assign a unique identifier to every specification item across all project documentation that strictly matches the regular expression structure: ^[A-Z]{4,5}-OB-[0-9]{3,4}$.

RULE-OB-012
3.3.4.2. Document Prefix Code Classification RULE-OB-012

The author MUST restrict the prefix of requirements to one of the exact six system tokens defined in the Nomenclature Standard: RULE-OB-, GAME-OB-, REQ-OB-, SPEC-OB-, PLAN-OB-, or TEST-OB-.

RULE-OB-013
3.3.4.3. Sequential Number Padding Strategy RULE-OB-013

The author MUST format the numeric ID variable as a sequential integer left-padded with zeros up to a minimum length of three digits.

OB-SQMP-REVI

3.3.5. Version Control and Lifecycle Management

OB-SQMP-REVI
RULE-OB-014
3.3.5.1. Deprecated Identifier Preservation RULE-OB-014

The author MUST NOT reuse or reassign the ID of a deleted or deprecated specification.

RULE-OB-015
3.3.5.2. Specification Lifecycle Status Field RULE-OB-015

The author MUST update the STATUS field to Deprecated when a specification is retired from the project scope.

RULE-OB-016
3.3.5.3. Version Increment Rule RULE-OB-016

The author MUST increment the version number by a step of 0.1 for minor cosmetic changes and by 1.0 for major technical modifications.

RULE-OB-017
3.3.5.4. Mandatory Context Fields RULE-OB-017

The author MUST provide non-empty values for RATIONALE, DEPENDENCIES, and VERIFICATION_METHOD within every specification item.