Запросить демо
Запросить демо
Документерра: руководство пользователя

Метрики страниц

Техническое писательство — это объяснение сложных понятий простым языком. Но как убедиться, что ваша целевая аудитория поймет вашу документацию? Здесь на помощь приходят метрики. Система Документерра предоставляет авторам набор метрик, которые помогут вашей команде создавать удобочитаемую документацию. Ниже приведен список всех метрик, которые вы можете использовать для своих проектов и страниц:

Текстовые метрики

  • Слова
  • Символы
  • Символы (без пробелов)
  • Предложения
  • Слоги
  • Уникальность текста (слова, % от общего количества)
  • Печатные страницы (формат A4)
  • Печатные страницы (формат почтовой бумаги)
  • Среднее количество слов в предложении
  • Среднее количество слогов в предложении
  • Среднее количество символов в предложении
  • Среднее количество слогов в слове
  • Среднее количество символов в слове.

Для получения более подробной информации обратитесь к этому разделу: Текстовые метрики.

Метрики удобочитаемости

  • Метрика «Время прочтения»
  • Индекс удобочитаемости Флеша
  • Индекс Флэша-Кинкейда
  • Индекс туманности Ганнинга
  • Индекс Колман-Лиау
  • Автоматический индекс удобочитаемости
  • Индекс SMOG
  • Формула Linsear Write
  • Формула Дейла-Чалл
  • Оценка FORECAST
  • Средняя оценка

Для получения более подробной информации обратитесь к этому разделу: Метрики удобочитаемости.

Общие метрики

  • Дата обновления

Для получения более подробной информации обратитесь к этому разделу: Общие метрики.

Метрики подсчета элементов

  • Изображения
  • Ссылки
  • Таблицы
  • Видео
  • Сниппеты
  • Переменные
  • Условные включаемые блоки
  • Условные исключаемые блоки
  • Разрешенные комментарии рецензента
  • Удаленные комментарии рецензента

Для получения более подробной информации обратитесь к этому разделу: Метрики подсчета элементов.

Выбор метрик для отображения

В верхнем колонтитуле страницы вы можете увидеть три метрики.
Метрики, отображаемые в верхнем колонтитуле страницы

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

Более того, вы можете просматривать все метрики на одном экране. Нажмите значок шестеренки, затем нажмите Все метрики на одном экране...
Ссылка «Все метрики на одном экране» в верхнем колонтитуле страницы

Вот еще один способ увидеть все метрики по странице:

  • Нажмите кнопку с тремя вертикальными точками, затем нажмите Настройки...
    Нажмите на «Свойства страницы» в Дереве страниц
  • Либо щелкните Меню действий в верхнем колонтитуле страницы и выберите Свойства.
    Нажмите на «Свойства страницы» в главном меню страницы
  • Затем нажмите Метрики страницы, и вы увидите все метрики по вашей странице.
    Раздел «Метрики страницы» в свойствах страницы

Чтобы повысить эффективность документации, вы можете использовать другие функции Документерры, такие как: