О чём урок
Используйте эти чек-листы для быстрого ознакомления с общими рекомендациями.
- Используйте только те акронимы, которые знакомы вашей аудитории.
- Для большинства акронимов сначала полностью напишите термин и укажите акроним в скобках. При последующих упоминаниях используйте акроним без расшифровки.
- Пишите все слова в расшифровке акронима со строчной буквы, за исключением имён собственных.
- Не расшифровывайте акроним, если он широко известен (например, API, SDK, JSON, HTTP).
- Не вводите акроним, который используется всего один раз.
- Избегайте первого использования акронима в заголовке или подзаголовке, если только это не ключевое слово, необходимое для поиска.
- Используйте артикли a или an в зависимости от произношения акронима (например, an MCP server, a SDK, an API key).
- Образуйте множественное число акронима как у любого другого существительного (например, three APIs, two SDKs).
- Не используйте притяжательную форму акронима, если только он не относится к человеку или организации.
- В контенте, который будет локализован, будьте осторожны с акронимами, образующими обычные слова — они могут быть переведены неверно.
- Везде используйте регистр предложений: пишите с заглавной буквы только первое слово и имена собственные.
- Всегда пишите имена собственные с заглавной буквы (Mistral, Python, TypeScript, GitHub и т.д.).
- Всё остальное пишите со строчной буквы в предложениях, заголовках, названиях и метках UI.
- Не пишите с заглавной буквы расшифровку акронима, если только это не имя собственное.
- Используйте регистр заголовков для названий продуктов и сервисов (Mistral Large, Codestral, Vibe).
- В коде следуйте правилам использования заглавных букв, принятым в языке программирования или среде.
- Не используйте все заглавные буквы для выделения.
- Не используйте все строчные буквы в качестве стилистического приёма.
- Используйте глаголы в настоящем времени: is, opens, returns. Избегайте will, was и форм прошедшего времени.
- Используйте изъявительное наклонение для утверждений о фактах. Используйте повелительное наклонение для процедур и инструкций.
- Предпочитайте активный залог. Субъект выполняет действие. Активный залог: "The model calls the tool."
- Пассивный залог: "The tool is called by the model." (избегать)
- Неоднозначно: "Processing requests…
План урока
- Чек-лист по акронимам
- Чек-лист по использованию заглавных букв
- Чек-лист по грамматике и частям речи
- Чек-лист по числам
- Чек-лист по процедурам и инструкциям
- Чек-лист по пунктуации
- Чек-лист по адаптивному контенту
- Чек-лист по форматированию текста
Урок входит в полный доступ. Полный текст и видео открываются после оплаты. Первые уроки каждого курса бесплатны.