Skip to content
Apothem
Справочник

Соглашения о прозе

Обеспечивает модальную иерархию RFC 2119, запрещает маркетинговые прилагательные и уклончивый наполнитель, использует абсолютные даты ISO-8601 и проверяет герметичность директивной прозы.

Каноническая справка по дисциплине прозы на каждой написанной поверхности Markdown. Сводка в CLAUDE.md Соглашения — это встроенное объявление; эта страница — самостоятельная справка, на которую ссылаются участники ниже по потоку.


1. Модальная иерархия (RFC 2119)

Директивная проза использует модальную иерархию RFC 2119: MUST, MUST NOT, SHOULD, SHOULD NOT, MAY. Каждый несёт силу обязательности, которую определяет RFC. Модальные слова в нижнем регистре (must, should) не несут нормативного веса и используются только в повествовательной прозе, где никакое обязательство не объявляется.

2. Запрещённый словарь

2.1 Маркетинговые прилагательные

Термины powerful, seamless, robust, cutting-edge, next-generation, world-class, enterprise-grade и эквиваленты запрещены в обращённых к пользователю артефактах, если они конкретно не подкреплены измеренными доказательствами. Подтверждение ссылается на бенчмарк, сравнение, измерение или внешний источник валидации.

2.2 Уклончивый наполнитель

Термины basically, kind of, sort of, in some sense, to some extent и эквиваленты запрещены в директивном тексте. Директивная проза обязательна; уклончивый наполнитель уступает силу обязательности, на которую проза претендует.

2.3 Герметичность UDA

Проверка универсальной директивной герметичности (UDA) в scripts/dev/validate_ecosystem.py обеспечивает закрытый лексикон уклончивых слов (maybe, might, could, should probably, usually, generally speaking, in most cases, mostly, typically, often, or similar, etc., and so on) на строках, несущих обязательное предписание. Уклончивые токены, цитируемые как собственный предмет правила (например, список запрещённых слов на странице запретного списка), освобождаются механизмом определяющего маркера валидатора.

3. Ссылки на даты

Даты — абсолютные ISO-8601 (YYYY-MM-DD) при каждой ссылке. Относительные даты (yesterday, last week, recently) запрещены в артефактах, сохраняющихся за пределами сессии их создания.

4. Валидаторы

Проверка герметичности UDA в scripts/dev/validate_ecosystem.py — это поверхность механического обеспечения для §2.3. Семейство markdown валидаторов conformity-grep, выполняемых при каждой записи, обеспечивает более широкую планку качества прозы на границах хуков PreToolUse Write/Edit.

On this page