Перейти к основному содержимому

Типографика

warning

Эта страница переведена сообществом на русский язык, но нуждается в улучшениях. Если вы хотите принять участие в переводе свяжитесь с @alexgton.

Введение​

Этот стандарт обеспечивает единообразный и профессиональный стиль в документации TON.

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

Имена файлов​

  • Соглашение об именовании: используйте kebab-case — все строчные буквы, слова разделены дефисами.
  • Пример: kebab-case-file-name.md
  • Цель: Kebab-case дружелюбен к SEO, легко читается и помогает избежать конфликтов имен или проблем в файловых системах, чувствительных к регистру.

Типографика документов​

Общий стиль текста​

  • Пишите краткие, понятные предложения.
  • Используйте простой, прямой язык, подходящий как для новых, так и для опытных пользователей.
  • Избегайте слишком сложных структур; стремитесь к ясности и краткости.
  • Избегайте чрезмерного использования жирного или курсивного начертания.
  • Все графические элементы, содержащие текст, должны использовать шрифт Inter или аналогичный совместимый шрифт.

Сокращения​

При введении незнакомого сокращения напишите весь термин и заключите сокращение в скобки. Выделите как полный термин, так и сокращение жирным шрифтом.

Пример:

The Open Network (TON) — это децентрализованная и открытая интернет-платформа...

Заголовки​

Иерархия заголовков:​

  1. H1 (#) — Название документа
  2. H2 (##) — Основные разделы
  3. . H3 (###) — Подразделы в H2
  4. H4 (####) и ниже — Используйте экономно для более мелких деталей

Стиль заглавных букв в заголовках:​

  • H1, H2, H3 и H4: Регистр предложений

    • Пример: # Это предложение в заглавных буквах
    • Пример: ## Это предложение в заглавных буквах
    • Пример: ## Это предложение в заглавных буквах
    • Пример: ### Это предложение в заглавных буквах

  • Исключение: Специальные термины. Несмотря на общее правило падежа предложения, определенные слова или фразы — ключевые концепции или определенные термины в документации — всегда должны форматироваться с использованием заглавного регистра.

    • Пример: # Используйте американский английский
    • Пример: # Запустите службу TON Center

Согласованность заголовков:​

  • Избегайте повторения одних и тех же слов в последовательных заголовках.

Термины в заголовках пишутся с заглавной буквы​

Иногда вы можете столкнуться с определенными заглавными буквами, которые пишутся с заглавной буквы в соответствии с правилами американского английского.

  • Стандарт использования заглавных букв для определенных терминов:
  • Пример: ## Use American English
  • Пример: ### Date Format

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

Заголовки меню навигации​

Меню навигации должны оставаться минималистичными как в левой боковой панели, так и в верхнем меню. Для согласованности и ясности все заголовки меню должны использовать Sentence case.

Меню левой боковой панели:​

  • Избегайте длинных описаний.
  • Используйте короткие, понятные надписи из двух-трех слов.
к сведению

Укажите левое боковое меню с помощью файлов конфигурации боковой панели.

Меню панели навигации:​

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

Укажите меню панели навигации с помощью файла конфигурации navbar.js.

Согласованность между меню и заголовками на странице​

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

Объединяем все это вместе​

  1. Создайте новый файл документации, используя соглашение об именовании в стиле kebab-case
    • Пример: getting-started-guide.md.
  2. Откройте файл и установите заголовок H1 в sentence case
    • Пример: # Руководство по началу работы.
  3. Организуйте контент с помощью заголовков H2 по основным темам.
    • Пример: ## Шаги установки, также в sentence case.
  4. Используйте заголовки H3 для более подробных подтем в sentence case
    • Пример: ### Установка на Linux.
  5. **Поддерживайте согласованность ** в любых боковых меню или оглавлениях, сопоставляя текст заголовка с текстом документа.

Пример структуры​

getting-started-with-ton.md
# Getting started with TON

## Prerequisites

### What is TON
**The Open Network (TON)** is a decentralized and open internet platform...
The content goes here.

### Checking your environment
The content goes here.

## Installation steps

### Installing on Linux
The content goes here.

### Installing on macOS
The content goes here.

## Basic usage

### Running your first command
The content goes here.

## See also
- [How to contribute](/v3/contribute/)

См. также​