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

Один наиболее важных элементов современного проекта в сфере информационных технологий является разработка документации. Каждая современная ИТ-компания снабжает свои продукты рекламными и техническими документами. В настоящей части рассмотрены основные типы документов, которыми комплектуются программно-технические средства (ПТС) и автоматизированные системы (АС), и представлены наиболее распространённые варианты переводов. Так же как и в других частях перечень рассмотренных терминов не может быть полным, но может позволить выбрать наиболее правильную версию перевода названия того или иного документа.

Примечание: В настоящем документе рассматривается документация, которая создаётся в процессе разработки, модернизации и эксплуатации АС и ПТС. В контексте документа предполагается, что АС представляет собой конечный набор ПТС.

 

Все компании предъявляют уникальные требования к составу и содержанию документов к своей продукции. Тем не менее, большинство этих требований основаны на положениях и рекомендациях национальных стандартов или распространённой мировой практики.

В России распространены четыре системы разработки документации в области ИТ. Это единая система конструкторской документации (ЕСКД, ГОСТы 2-й серии), единая система программной документации (ЕСПД, ГОСТы 19-й серии), комплекс стандартов на автоматизированные системы (КСАС, ГОСТы 34 серии) и переведённые и адаптированные международные стандарты (ГОСТы Р ИСО/МЭК).

С точки зрения российских ГОСТов 34 серии, проект по созданию АС должен включать в себя следующие стадии:

На каждом из этих этапов разрабатываются или применяются различные документы, которые условно можно разбить на следующие группы:

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

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

Также помимо официальных названий документов в практической работе могут встречаться различные жаргонные названия документов, такие как «рыба», «синька» и т.п. В рамках данной статьи они рассмотрены не будут.

 

Помимо стадий создания ПТС и АС, описанных в российских ГОСТах, существует несколько моделей жизненного цикла ПТС и АС. Среди наиболее распространённых – цикл Деминга (англ.: Deming Cycle или Plan-Do-Study-Act). Тем не менее, различия в документации при работе над созданием или модификацией ПТС или АС для различных моделей не существенны или отсутствуют вовсе.

 

Термин Концептуальная документация (КД) не является общепринятым и широко распространённым. Он введён нами специально для разбиения на отдельные группы по видам документации. Под концептуальной документацией мы будем понимать документы, которые описывают текущую ситуацию в АС и определяют требования к созданию новой АС или модернизации существующей. Для перевода на английский язык термина концептуальная документация целесообразно использовать термин conceptual documentation.

 

В российской практике документы, которые отнесены нами к концептуальной документации разрабатываются на стадиях 1-4 ГОСТа 34.601. Среди наиболее распространённых можно отметить следующие документы.

Отчёт обследования (ОО) – аналитический отчёт, содержащий результаты обследования объекта автоматизации. Так как обследование АС иногда называют аудитом, то данный отчёт может быть назван «Отчёт по аудиту», «Аудиторский отчёт» или «Отчёт по аудиторской проверке», тем не менее, такое название не рекомендуется, так как термин «аудит» широко распространён в бухгалтерии, что может спровоцировать ошибки. В практике бюро переводов «Интана-Прайз» для представления названия данного отчёта на английском языке используется термин Audit report или Report of inspection.

В ходе процесса обследования могут быть применены или созданы различные типы документов, например, опросный лист (англ.:  feedback form), перечни (list) или ведомости (list) некоторых элементов объекта автоматизации (например, перечень типов информации), протоколы интервью (record of interview) или протоколы встреч (record of meeting) и т.д.

Концепция – данный документ содержит общие описание создаваемого программно-технического средства. В англоязычной литературе для обозначения этого понятия может быть применён термин conceptual design. На практике концепция создания или модернизации ПТС является более распространённым названием эскизного проекта, который определён в ГОСТе 34.601-90 как документ, в котором описаны функции АС, функции подсистем, их цели и эффекты, состав комплексов задач и пр.

Примечание: При формировании названия документа необходимо указать в явном виде название проводимой операции, например, «Концепция создания системы обеспечения информационной безопасности». Название «Концепция системы обеспечения информационной безопасности» следует применять очень осторожно.

В рамках разработки концепции может быть подготовлен  документ Технико-экономическое обоснование (ТЭО), которое в англоязычной литературе обозначают термином technical and economic assessment. В данном документе могут быть рассмотрены несколько вариантов решения определённых задач и представлены логические и математические аргументы для выбора конкретного решения.

Технические требования (ТТ) – это документ, содержащий требования к создаваемой или модернизируемой системе. В англоязычной литературе для обозначения такой документации используется термин requirements. В зависимости от степени проработки требований и сложности объекта автоматизации, объём документа может быть от одной-двух страниц до нескольких десятков, в которых могут содержаться как конкретные технические требования, так и требования к эргономике и технической эстетике. На практике ТТ часто включаются в состав технических условий, технического задания и правил эксплуатации программно-технических средств.

Помимо ТТ в процессе создания или модернизации АС могут быть подготовлены Технические условия (ТУ). Данный документ содержит ТТ, в дополнении с требованиями по экологической безопасности, безопасности человека и т.п.. Для обозначения данного документа в англоязычной литературе следует использовать термин technic specifications.

Техническое задание (ТЗ) – документ, в котором содержится постановка задачи для выполнения работ по создания или модернизации АС или ПТС. Требования к содержанию ТЗ определены в ГОСТе 34.602-89. В англоязычной практике техническое задание может быть обозначено термином requirement description.

 

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

Международная практика документирования несколько отличается от российской. Тем не менее, в ней распространены и документы, аналогичные российским, например, requirements (ТТ), technical and economic assessment (ТЭО) и пр.

Помимо этого, крупные производители вычислительной техники и программного обеспечения публикуют собственные универсальные методики создания отдельных элементов АС и ПТС. Среди таких методик можно упомянуть документы под названием blueprint. Для перевода названия данного документа следует использовать термин методическое пособие или методические указания. В России такая практика не очень распространена. Как правило, методические пособия и указания разрабатываются и применяются только в ходе учебного процесса в высших учебных заведениях (ВУЗах).

Крупные проекты в области ИТ предполагают разработку нескольких десятков и даже сотен документов. Сам термин проектная документация в различных кругах специалистов может быть истрактован по-разному. В англоязычной литературе для термина проектная документация можно применить термин Design document.

Проектирование – это неотъемлемая стадия создания АС. На этапе проектирования создаётся существенное количество документов. На этом этапе разрабатывается пакет проектной документации и эксплуатационная документация, а также могут готовиться рекламные материалы.

Основой проектирования является разработка Технического проекта (ТП). Для обозначения технического проекта в англоязычной литературе используется термин Technical design. Технический проект представляет собой довольно объёмный пакет документации, основу которого, как правило, составляет пояснительная записка. Для англоязычной литературы пояснительную записку следует называть memorandum to Technical design или Technical Memorandum.

Рабочий проект (РП) – редко встречаемый документ в сфере ИКТ. Как правило, такие документы чаще встречаются в строительстве. Данный документ предполагает выполнение привязки более общего технического проекта к конкретному объекту автоматизации. Например, компания обладает обширной филиальной сетью, но во всех филиалах внедряется схожие инженерные решения, отличающиеся некоторыми параметрами, такими как адреса серверов, количеством используемых лицензий и т.п., которые и отражаются в рабочем проекте. В англоязычной литературе для рабочего проекта применяется термин installation design.

Техно-рабочий проект (ТРП) – один из наиболее распространённых форматов проектной документации. Объединяет в себя технический и рабочий проекты. Широкое распространение данных документов стало следствием того, что большинство ИТ-проектов реализуются в единственном экземпляре и не требуют массового копирования по филиальной сети, что позволяет объединить ТП и РП в единый документ. Для английского языка может быть использован термин (technical working design)

В состав ТП, РП, ТРП и прочих документов могут входить различные документы, такие как, схемы (schematics), чертежи (drawing), спецификации (specification), таблицы (table) и пр.. Данные документы могут входить в состав пояснительной записки, являться приложением к нему или оформлены в виде самостоятельного документа.

При создании АС и ПТС в международной практике встречаются такие документы как Architecture documentation. В данном документе объясняется архитектура ПТС или АС. В русском языке для данных типов документов применяется термин Архитектура.

Примечание: отдельно этот термин не используется. Всегда термин архитектура дополняется уточнениями, например архитектура базы данных или архитектура системы защиты данных.

 

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

В российской практике широко распространён термин Организационно-распорядительная документация (ОРД). Как правило, ОРД разъясняет особенности организационной части работы с программно-техническими средствами. В состав ОРД входит целый комплект документов, в который могут быть включены должностные инструкции (англ.: position description), инструкции пользователя, информационные политики (policies) и прочие документы. Для англоязычной литературы может быть использован термин organizational-administrative documentation (ОАD).

Примечание: упомянутые информационные политики являются общим термином и на практике слово «информационная» из названия документа исчезает. Таким образом, документ может носить название, например, «Политика парольной защиты» и т.п..

Каждое ПТС является объектом авторского права. Правила применения того или иного ПТС определяются либо договором (англ.: Contract) на его использование, либо лицензией (англ.: License). Юридическим вопросам ИТ-сферы будет посвящена отдельная часть статьи.

Переводу АС в режим эксплуатации (как опытную, так и промышленную) предшествует проведение контрольных испытаний. Такие испытания проводятся на основании программы и методики испытаний (ПМИ). В англоязычной литературе для ПМИ используется термин Program and methods of testing. По результатам проведённых испытаний формируются протоколы испытаний (англ.: test report).

Среди наиболее часто встречаемых документов по эксплуатации АС и ее компонентов – руководство пользователя (англ.: user’s manual или user’s guide) и руководство администратора (administrator’s guide). Этими документами снабжаются практически все ПТС и АС. Данные документы, как правило, содержат подробные сведения о настройке и эксплуатации АС и ПТС. Объем таких документов может достигать нескольких сотен и тысяч страниц.

Одним из самых распространённых видов документов для настройки или эксплуатации ПТС являются пошаговые инструкции. По своей сути данные документы представляют собой перечень действий, необходимых для выполнения определённой задачи. Пошаговые инструкции можно встретить во многих эксплуатационных документах, хотя зачастую их отдельно не выделяют. В англоязычной литературе для обозначения такой инструкции используются термины Step-by-Step instruction или Step-by-Step Guide.

Для упрощения процедур инсталляции и запуска ПТС разработчики могу комплектовать свои продукты руководствами по инсталляции (РПИ, англ.: Installation manual или Install guide или Installation guide) или руководствами по вводу в действие или руководствами по развертыванию (РВД, англ.: Deployment Guide или Deployment Guidelines или Deployment Manual). Последние документы иногда на русском языке могут называться гидам: гид по вводу в действие или гид по развертыванию. Помимо термина «руководство» в названии данных документов можно встретить термин «методическое пособие». Но в бюро переводов Интана-Прайз предпочитают использовать в отношении таких документов термин руководство, чем они по сути и являются.

Часто программно-технические средства комплектуются руководствами быстрого запуска. Данный документ представляет собой краткую инструкцию для администратора, позволяющей выполнить настройку основных параметров программно-технических средств, входящих в состав АС. Как правило, объём таких документов составляет несколько страниц, а сами документы хорошо иллюстрированы. Обычно в данное руководство включают пошаговые инструкции по правилам подключения оборудования в электросеть, правилам коммутации ПТС с различными устройствами и т.п. В англоязычной литературе для обозначения такой документации используется термин QuickStart, QuickStart Tutorial или QuickStart Guide.

В составе документации сложных программно-технических средств можно встретить руководства «Приступая к работе». Как правило, данные руководства предназначены для ввода пользователя в среду ПТС и АС, предоставляя набор основных пошаговых инструкций, необходимых для начала работы. В англоязычной литературе для обозначения данного руководства применим термин Getting Started.

Очень часто ПТС средства комплектуются такими документами как Диагностика неисправностей (ДН). В данном документе рассмотрены способы выявления наиболее распространённых неисправностей и способы их устранения. В англоязычной литературе для таких документов применяют термин Troubleshooting.

Иногда компании предоставляют в качестве первой линии поддержки пользователей такие сервисы как Базы знаний. В английском языке данные базы принято обозначать термином  Knowledge Base. Данная база не является законченным документом, а представляет собой некоторое хранилище данных по работе ПТС и АС. Данные службы часто размещаются на корпоративных сайтах крупных производителей программного обеспечения.

 

В состав рекламных материалов (которые также называют маркетинговыми материалами, промо-материалами и т.п.), помимо документации могут входить различные демонстрационные стенды, версии программного обеспечения ограниченного функционала, стенды, одежда, различная сувенирная продукция и т.п..

Как правило, компания, претендующая на выполнение заказных работ, готовит Технико-коммерческое предложение (ТКП), также иногда называемое Коммерческое предложение (КП). В англоязычной литературе для обозначения данного документа используется термин technical and commercial proposal или просто proposal. Данные документы могут быть разработаны на основе отчёта обследования, технического задания или технических требований и содержать конкретные предложения по решению стоящих технических задач с оценкой затрат.

Выпуская новую версию программы или технического средства компании, как правило, публикуют документы под названием Release Notes. Как правило, в данных документах содержатся общие сведения о данном ПТС, его технических требованиях, процессе покупки и установки, ответы на распространённые вопросы и т.п. На русский язык данный термин следует переводить заметки к выпуску.

Достаточно часто встречаются документы, относимые к категории White paper. Подобные документы до 1990-х годов разрабатывались в основном государственными учреждениями для ознакомления общественности с официальной позицией государства по каким-либо вопросам и стратегией дальнейших действий. В последнем десятилетии XX века документы под этим названием стали публиковаться различными компаниями, в том числе ИТ-компаниями. Как правило, корпоративные документы предназначены для технических или рекламных целей, описывая преимущества конкретных решений компаний. Для государственных документов данной категории существует устоявшийся термин «Белая книга». В случае с коммерческими документами существует несколько версий перевода: «технический документ», «официальный документ» и «белая книга». В целом все эти варианты перевода применимы. Например, корпорация Майкрософт используется термин «технический документ». В практике бюро переводов Интана-Прайз принято использовать термин «официальный документ».

В международной практике распространены документы под названием Datasheets, в которых содержатся краткая информация о ПТС и АС. Объем таких документов обычно невелик и составляет 1-2 страницы. Данные документы на русском языке обычно называют Краткие сведения.

Среди производителей ПТС распространена практика разработки документов Frequently Asked Questions (FAQ). В русскоязычной литературе можно встретить несколько вариантов перевода данного термина: вопросы и ответы (ВиО), часто задаваемые вопросы (ЧЗВ), частозадаваемые вопросы и ответы (ЧаВО). Каждый из данных терминов является довольно широко распространенным и применимым. Ограничения можно ввести только для разных аудиторий, так для официальных корпоративных документов более распространены первые две версии терминов, для частного использования (развлекательные Интернет-страницы) часто применяется третья версия термина. В практике бюро переводов «Интана-Прайз»  предпочтение отдаётся термину ВиО. На страницах данного документа можно найти ответы на наиболее распространённые вопросы, вида «что? где? когда? сколько? как?». Данные документы обычно применяются в рекламных целях. Изредка такие документы используются для поддержки пользователей (по аналогии с документами диагностики неисправностей), однако это делается довольно редко, так как это вызывает ассоциацию, что неисправности в данном ПТС – явление частое.

 

За перевод ИТ-документации готовы взяться довольно большое количество специалистов. Причем зачастую это берутся делать не только лингвисты, но и технические специалисты, которые не всегда компетентны в особенностях языка источника документа и имеют своё представление на профессиональную терминологию. Как следствие происходит довольно сильное размытие терминологии. На рынке лингвистических услуг присутствует несколько бюро переводов, которые специализируются на переводе ИТ-документации. В 2008 году в бюро переводов Интана-Прайз создан специализированный отдел лингвистических услуг в области информационных технологий (ЛУИТ), целью которого является не только выполнение качественных работ по переводу, корректуре, редактированию ИТ-текстов, но и участие в выработке единой ИТ-терминологии. Обращаясь за переводом в ЛУИТ Интана-Прайз, Заказчик всегда может рассчитывать на получение услуг высокого качества и жесткое соблюдение сроков, а также поддерживает проведение научных работ в области языкознания.