Подготовка текстов профессиональной направленности
Научный стиль и требования к текстам
Тексты ИТ-сферы функционируют на стыке научного и официально-делового стилей. Основа таких текстов — научный стиль. Его главная функция заключается в передаче логической информации и доказательстве её истинности. Основные признаки: отвлеченно-обобщенный характер, объективность, логичность и безличность изложения.
К профессиональным текстам предъявляются четыре жестких требования. Точность (прямое предметно-логическое значение слов без образных средств). Однозначность (исключение любой двусмысленности). Логичность (явная причинно-следственная связь, использование вводных слов «следовательно», «таким образом»). Структурированность (сквозная нумерация, заголовки, списки, перекрестные ссылки).
Жанры текстов ИТ-специалиста
Деятельность ИТ-специалиста сопровождается написанием специфических документов. Техническое задание (ТЗ) фиксирует требования к продукту и порядок приемки (оформляется по ГОСТ 19 или ГОСТ 34). Инструкция пользователя — это операционный документ, использующий повелительное наклонение («для запуска нажмите...»).
Отчет о тестировании фиксирует результаты проверки кода; при описании дефектов используется нейтральный стиль (запрещены жаргонизмы вроде «баг висит»). README-файл — это сопроводительный файл в корне репозитория с исходным кодом, де-факто являющийся международным стандартом описания проекта (включает разделы об установке, авторах и лицензии).
Языковые средства профессиональных текстов
В технической документации широко используются термины, интернационализмы и аббревиатуры (API, СУБД), которые необходимо расшифровывать при первом упоминании. Для создания эффекта объективности применяются безличные предложения и страдательные причастия: «запрос выполняется сервером», «значение сохраняется».
Еще одна важная черта — использование «вневременного настоящего» времени (например, «программа выполняет алгоритм», а не «будет выполнять»). Для связи предложений активно применяются слова-скрепки (следовательно, отчасти, во-первых). Неотъемлемой частью ИТ-документации является графический язык: таблицы, схемы, листинги кода и графики.
Глоссарий терминов
- Научный стиль — речевая система, приспособленная для передачи логической информации и доказательств в научной сфере.
- Техническое задание (ТЗ) — документ, фиксирующий требования к программному продукту (композиция: назначение, требования, порядок контроля).
- Инструкция пользователя — операционный документ с пошаговым описанием действий для работы с программой.
- README — сопроводительный текстовый файл (обычно формата .md) в репозитории кода, содержащий описание проекта.
- Репозиторий — хранилище исходного кода проекта и истории его изменений.
- Среда разработки (IDE) — программный комплекс, объединяющий редактор кода, компилятор и отладчик.
- Тест-кейс — формализованное описание шагов и ожидаемых результатов для проверки работы функции.
- Вневременное настоящее — грамматическая форма глагола, используемая в технических текстах для описания постоянных процессов («система обрабатывает»).