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

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

Это набор правил о том, как писать и оформлять Акты. Если все будут им следовать, то наши документы будут выглядеть одинаково и их будет легко читать.

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