1.0. Требования SQLite

• Требования состоят из выдержек из документации. Требование обычно это выдержка с одним предложением, но могло бы быть частью предложения, многократными предложениями, таблицей или изображением GIF диаграммы синтаксиса.

• Требования написаны на диалоговом английском языке, и без модального вспомогательного глагола "shall". Это растет из того, что требования взяты из документации. Целевая аудитория для документации это прикладные программисты. "Shall" будет соответствующим, когда аудитория будет состоять из специалистов по контракту, аудиторов QA и адвокатов, но это вмешивается в понимание, когда аудитория это прикладные программисты. Следовательно, чтобы лучше всего служить целевой аудитории, "shall" пропускается.

• Требования достаточно детализированы и точны, чтобы разрешить 100% совместимое переопределение окружения SQLite.

• Слово "требование" в общем английском использовании подразумевает заказ: то, что требование прибывает перед внедрением. Но нет такого заказа с требованиями SQLite. Что называют "требования" в SQLite лучше описано как "тестируемые заявления о поведении системы".

• Каждое тестируемое заявление о SQLite в документации становится требованием.

• Числа требования это хэши MD5 самого требования.

  1. Требования неотъемлемо неизменны, начиная с любого изменения результатов требования в совершенно другом числе требования.

  2. Для текстовых требований текст нормализован до вычисления хэша MD5:

     • Удалите все начальные и конечные пробелы.
     • Преобразуйте все внутренние пробелы в символ одиночного пробела.
     • Преобразуйте "&lt;" в "<", "&gt;" в ">", "&#91;" в "[", "&#93;" в "]" и "&amp;" в "&".

  3. Для требований диаграммы синтаксиса GIF хэш MD5 вычисляется по всему содержанию файла изображения GIF.

  4. Хэш MD5 выражается в человекочитаемой форме следующим образом:

     R-N-N-N- N-N-N-N- N

     Здесь каждый N это число с 5 цифрами между 00000 и 65536, которое представляет 16 битов 128-битного хэша MD5.

  5. На требования может сослаться любой уникальный префикс полного числа требования.

• Отдельные текстовые требования идентифицируются в документации как текст между "^" и первым периодом или точкой (".") или как текст между "^(" и ")^".

  1. Текстовые требования автоматически извлечены из документации скриптами, которые работают как часть процесса сборки документации.

  2. После того, как требования были извлечены из документации, маркеры требования "^", "^(" и ")^" удалены из текста документации. Это сделано автоматически.

  3. Чтобы избегать столкновений с этими разделителями требований, символы "^", которые являются частью текста требования или которые иначе найдены в документации, должны быть закодированы как "&#94;".

• Отдельные требования диаграммы синтаксиса GIF идентифицируются в документации как HTML изображения формы

  <img alt="syntax diagram NAME" src="FILE">

  Здесь NAME это название диаграммы синтаксиса, и FILE это название файла GIF, содержащего диаграмму синтаксиса.

  1. Требования диаграммы синтаксиса автоматически извлечены из документации скриптами, работающими как часть процесса сборки документации.

  2. Файл GIF это требование, не разметка HTML, которая ссылается на файл GIF, и не название диаграммы.

• Документация, которая содержит текст требования, произведена скриптами, которые используют в качестве входных данных файлы в хранилище fossil и комментарии в исходном коде.