Техническим писателям
Для разработки технической документации на продукцию в сфере ИТ, разработки технических документов информационно-методического назначения, управления технической информацией. Используйте для:
- Разработки технических заданий
- Разработки руководств пользователя
- Разработки технологических инструкций и регламентов
- Документирования программных и системных архитектур
- Разработки комплекта документов по ГОСТ 34
- Описания библиотек и API
Системным аналитикам
Для разработки и сопровождения требований к программному продукту, информационной системе или автоматизированной системе управления на протяжении их жизненного цикла. Применяйте для:
- Разработки требований и спецификаций
- Описания бизнес-процессов
- Подготовки протоколов совещаний и интервью
- Разработки функциональных требований
- Постановки целей
- Разработки стратегий и концепций
Технологии документирования в Вашем текстовом редакторе
ПЕНТА – программное обеспечение для автоматической проверки на соответствие требованиям и инструменты для работы с техническими текстами: управление перечнем сокращений, поиск дублированных фрагментов текста, расширенный поиск по документам.
- Правила проверки технической документации
- Критерии оценки технической документации
- Рекомендации по улучшению технической документации
- Инструменты для работы с техническими текстами
Технический язык
ПЕНТА ограничивает писателя в использовании грамматики, терминологии и речевых оборотов посредством регламентирующих правил, чтобы снизить или искоренить многозначность и сложность используемого языка. Реализация правил упрощенного технического языка опирается на стандарты ASD-STE100, УТР-1, ГОСТ Р 5804-2017 и адаптирована под разработку программной и технической документации.
Язык требований
Использование точного и простого языка при написании требований позволяет существенном образом облегчить их дальнейшую классификацию и понимание. Правила языка требований разработаны на основе стандарта программной и системной инженерии ISO/IEC/IEEE 29148:2018.
Как улучшить техническую документацию
Выбрать правила
ПЕНТА позволяет выбрать критерии и правила оценки документа в соответсвии с рекомендациями отечественных и мировых стандартов.
Проверить документ
ПЕНТА автоматически проверяет документ на соответствие правилам. Формирует количественную оценку качества.
Устранить несоответсвия
ПЕНТА дает рекомендации и помогает устранить несоответствия.
Правила проверки технической документации
Разделы
Раздел имеет содержимое
Выделение подраздела
Вложенность разделов
Количество подразделов
Нумерация разделов
Заголовки
Длина заголовка раздела
Точка в заголовке раздела
Заголовки соседних подразделов
Заголовок не имеет форму вопроса
Абзацы
Объем абзаца
Дублирование
Предложения
Объем предложения
Слова
Превосходная степень
Субъективный язык
Неявные местоимения
Неоднозначные обобщения
Отрицательные утверждения
Лазейки
Неограниченные условия
Сравнения
Разговорная речь
Производный предлог
Оглавление
Наличие оглавления
Раздел помещен в содержание
Сокращения
Сокращение объявлено
Сокращение используется
Сокращение объявлено до использования
Перечень сокращений
Порядок перечня сокращений
Приложения
Ссылки на приложения*
Порядок приложений*
Структура приложения*
Приложение в содержании*
Стиль
Первое и третье лицо*
Активный залог*
Причастия и деепричастия*
Повелительное наклонение*
Вводные слова*
Типографика
Слеш*
Смешанный язык
Терминология
Технические термины*
Критерии оценки технической документации
Краткость
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
Точность
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
Согласованность
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
Полнота
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
Корректность
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
Рекомендации по улучшению технической документации
Перечень несоответствий
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
Рекомендации по устранению
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
Исключения
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
Инструменты для работы с техническими текстами
Устранить дублирование
Дублирование в тексте возникает при частом использовании функций копирования и вставки. Дублирование увеличивает трудозатраты на обслуживание, потому что необходимо вносить каждое изменение несколько раз. Дублирование может привести к несоответствиям, если забыть изменить определенную часть документа. ПЕНТА позволяет найти и исключить дублирование в тексте.
Построить Перечень сокращений
ПЕНТА помогает автоматически сформировать перечень используемых в тексте сокращений и аббревиатур и поддерживать его в актуальном состоянии на всех этапах разработки документа.
Найти информацию
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
ПЕНТА для Microsoft Word
быстрое внедрение
Word – наиболее распространенный текстовый редактор. Популярен среди технических писателей за счет простоты внедрения и использования, возможности редактирования и рецензирования всеми, кто вовлечен в работу с технической документацией.
Автономная работа
ПЕНТА использует ресурсы локального компьютера. Работа не требует подключения к сети Интернет.
Широкая поддержка Microsoft Word
ПЕНТА работает с Word 2019, 2016, 2013 и 2010.
Избежать ошибок
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
Упростить разработку
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
Сократить сроки
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
Следовать стандартам
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
Цены и тарифные планы
Стандарт
Содержит все необходимые для работы с текстом функции. Полностью бесплатное использование. Всегда.
Бесплатно
Премиум
Содержит все необходимые для работы с текстом функции. Полностью бесплатное использование. Всегда.
100 р./год
Бизнес
Настройка и интеграция программного обеспечения под нужды бизнеса.