Тестовое задание для Технического писателя

1. ЗАДАНИЕ. Исправьте ошибки в определениях

Web интерфейс — это набор систем с помощью которых пользователь может взаимодействовать с сайтом, программой или приложением через браузер. Вебинтерфейсы стали популярны с ростом популярности интернета и с повсеместным распространением браузеров.

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

1.1. Исправьте ошибки в описании действия

Следующим шагом необходимо перезапускать веб-сервер nginx с правами супер пользователя. Выполните с помощью команды:

sdo systemctl restart nginx

РЕШЕНИЕ. Исправьте ошибки в определениях

Web-интерфейс — это набор элементов интерфейса, с помощью которых пользователь может взаимодействовать с сайтом, программой или приложением через браузер. Web-интерфейсы стали популярными с ростом популярности Интернета и повсеместным распространением браузеров.

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

1.1. Исправьте ошибки в описании действия

Следующим шагом необходимо перезапускать веб-сервер nginx с правами администратора. Выполните с помощью команды:

sudo systemctl restart nginx

2. ЗАДАНИЕ. Обработайте техническую информацию

Вот техническое описание, предоставленное разработчиком:

App supports incremental backups using CRC checksums. There's a native client daemon running in background that scans FS changes via low-level hooks. For scheduled jobs, we're using a custom task runner built in Rust, and data is stored in a compressed binary format in .dgz containers.

Задание:

РЕШЕНИЕ. Обработайте техническую информацию

How does the backup system work

The app creates backup copies by saving only the new or changed files, which saves time and storage space. A special program runs quietly in the background to track any file changes on your computer. Scheduled tasks are handled by our own tool written in Rust programming language. Your data is stored securely in compact binary format inside «.dgz» container files.

3. ЗАДАНИЕ. Инструкция пользователя

Представьте, что вы работаете над документированием десктопного приложения «DataGuard» — это утилита для автоматического резервного копирования и восстановления файлов. Вам нужно написать оглавление для руководства по установке приложения на Windows. Напишите план заголовков с разделами и подразделами, если потребуется.

РЕШЕНИЕ. Инструкция пользователя

Руководство по установке DataGuard на Windows. Оглавление

I. Подготовка к установке

  1. Требования к системе

II. Установка программы

  1. Загрузка установочного файла
  2. Запуск установки
  3. Настройка параметров установки
  4. Завершение установки

III. Начальная настройка

  1. Создание учетной записи пользователя
  2. Конфигурация резервного копирования
  3. Параметры хранения резервных копий

IV. Тестирование работоспособности

  1. Проведение тестового резервного копирования
  2. Проверка восстановительных операций

V. Решение возможных проблем

  1. Типичные проблемы и способы устранения
  2. Обратная связь и поддержка пользователей

VI. Заключение

  1. Важность регулярного резервного копирования.
  2. Преимущества использования DataGuard.
  3. Рекомендации по дальнейшему использованию и настройке.

4. ЗАДАНИЕ. Работа с текстом

Исходный текст:

При попытке запуска ВМ может возникнуть ошибка и она связана с конфликтом идентификаторов UUID. В этом случае пользователь может вручную отредактировать конфигурационный файл, который находится в каталоге /etc/pve/qemu-server. Однако необходимо убедиться, что виртуальная машина в этот момент не работает, иначе доступ к файлу будет заблокирован системой.

Задание:

  1. Отредактируйте текст так, чтобы он соответствовал требованиям профессиональной инженерной документации:
  2. Приведите короткую аннотацию (1–2 предложения), объясняющую, что делает данный фрагмент — как если бы он был частью справочной статьи или раздела «Устранение неполадок».

РЕШЕНИЕ. Работа с текстом

1. Отредактированный текст

При возникновении ошибки запуска виртуальной машины причиной может стать конфликт идентификаторов UUID. В данной ситуации рекомендуется выполнить следующие шаги:

  1. Убедитесь, что целевая виртуальная машина отключена и не запущена.
  2. Откройте соответствующий конфигурационный файл виртуальной машины, расположенный в директории /etc/pve/qemu-server.
  3. Отредактируйте необходимые значения UUID в данном файле.
  4. Сохраните внесённые изменения и повторно запустите виртуальную машину.

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

2. Аннотация

Данный фрагмент описывает процедуру ручного исправления конфликта идентификаторов UUID при ошибке запуска виртуальной машины ВМ. Подробно изложены пошаговые инструкции по редактированию соответствующего конфигурационного файла, расположенного в директории /etc/pve/qemu-server, с обязательным условием отключения целевой виртуальной машины.

↑