Техническое писательство — это искусство объяснять сложные концепции простым и понятным языком. Но как быть уверенным, что ваша целевая аудитория действительно понимает вашу документацию? Здесь на помощь приходят метрики.
Система Документерра предоставляет авторам набор метрик, которые помогают вашей команде создавать более удобочитаемую и эффективную документацию. Эти метрики позволяют оценить, насколько текст соответствует потребностям вашей аудитории.
Текстовые метрики
Система Документерра предлагает следующие метрики для анализа текстов:
- Слова: общее количество слов.
- Символы: общее количество символов, включая пробелы.
- Символы (без пробелов): количество символов, исключая пробелы.
- Предложения: общее количество предложений.
- Слоги: общее количество слогов.
- Уникальность текста: процент уникальных слов от общего количества.
- Печатные страницы:
- в формате A4;
- в формате почтовой бумаги.
- Средние показатели:
- количество слов в предложении;
- количество слогов в предложении;
- количество символов в предложении;
- количество слогов в слове;
- количество символов в слове.
Для получения более подробной информации обратитесь к разделу Текстовые метрики.
Метрики удобочитаемости
Система Документерра предоставляет следующие метрики для оценки уровня удобочитаемости текста:
- Метрика «Время прочтения»: оценивает время, необходимое для прочтения текста.
- Индекс удобочитаемости Флеша: измеряет сложность текста на основе длины предложений и слогов в словах.
- Индекс Флэша-Кинкейда: определяет минимальный уровень образования для понимания текста.
- Индекс туманности Ганнинга: оценивает сложность через использование длинных слов.
- Индекс Колман-Лиау: оценивает сложность на основе символов и предложений.
- Автоматический индекс удобочитаемости: рассчитывается на основе букв в словах и слов в предложении.
- Индекс SMOG: оценивает сложность через количество длинных слов (с тремя и более слогами).
- Формула Linsear Write: оценивает степень сложности текста, основываясь на количестве слов с тремя и более слогами в отрывке длиной не менее 100 слов.
- Формула Дейла-Чалл: оценивает сложность через соотношение «простых» и «сложных» слов.
- Оценка FORCAST: определяет сложность по количеству «простых» слов с одним слогом в отрывке длиной 100–150 слов.
- Средняя оценка: усредняет все метрики удобочитаемости, соотнося их с уровнем школьного обучения.
Для получения более подробной информации обратитесь к разделу Метрики удобочитаемости.
Общие метрики
- Дата обновления: указывает на дату последнего обновления документации.
Для получения более подробной информации обратитесь к разделу Общие метрики.
Метрики подсчета элементов
Включают следующие категории:
- Изображения
- Ссылки
- Таблицы
- Видео
- Сниппеты
- Переменные
- Условные включаемые блоки
- Условные исключаемые блоки
- Разрешенные комментарии рецензента
- Удаленные комментарии рецензента
Для получения более подробной информации обратитесь к разделу Метрики подсчета элементов.
Метрики страницы
Чтобы увидеть все метрики по странице, выполните следующие шаги:
- В редакторе страницы нажмите Ещё в верхней части страницы.
- Выберите Метрики страницы.
- После этого откроется раздел, где будут отображены все метрики по странице.
Для повышения эффективности работы с документацией, вы можете использовать дополнительные функции системы Документерра, такие как: