Акты Становления

Руководство по стилю для Актов

Стилистические правила для написания и редактирования :term[Актов]{canonical="activity" href="/ru/acts/003_agent_activity.md"} помогают обеспечить единообразие и читаемость всей документации.

  • Без жирных ссылок: Ссылки не должны быть выделены жирным. Стандартного стиля ссылок достаточно, чтобы указать на их интерактивность.
  • Термины из глоссария: Все термины, определённые в Глоссарии, должны быть оформлены с помощью синтаксиса :term[Название термина]{canonical="Term Name"}. Это обеспечивает их автоматическое связывание и единообразие стиля.
  • Встроенные ссылки на главы: Используйте синтаксис :term[План]{href="/ru/acts/010_agent_plan.md" canonical="plan"} (обратите внимание на относительную ссылку).
  • НЕ заменяйте ссылки на , если текст ссылки является полным названием, например, 010: Агент/План, но заменяйте, если это просто :term[План]{canonical="plan" href="/ru/acts/010_agent_plan.md"}.
  • Блок определения: Каждый :term[Акт]{canonical="activity" href="/ru/acts/003_agent_activity.md"} должен начинаться с блока > [!DEFINITION], который содержит определение термина из глоссария.
  • Заключительный блок: Каждый :term[Акт]{canonical="activity" href="/ru/acts/003_agent_activity.md"} должен завершаться специальным разделом, который обеспечивает понятный, повествовательный переход к следующему :term[Акту]{canonical="activity" href="/ru/acts/003_agent_activity.md"} в последовательности.
  • Ссылки в Sidenote: При ссылках на другие релевантные :term[Акты]{canonical="activity" href="/ru/acts/003_agent_activity.md"} или концепции используйте блок > Sidenote:. Это сохраняет основной текст чистым и предоставляет контекстуальные, не прерывающие повествование ссылки.
  • При разметке терминов не ставьте их в единственное число. Используйте множественное, например: :term[Действия]{canonical="activity" href="/ru/acts/003_agent_activity.md"}. Система автоматически сопоставит его с Activity.
  • Избегайте мета-ссылок вроде «этот документ» или «следующий документ». Старайтесь делать повествование более плавным.
  • Используйте :dfn[Термин]{canonical="..." href="..."} для определения терминов в глоссарии.