Я с удовольствием послушаю!

Если бы не ваш репозиторий, я бы в Sphinx три года разбиралась

А давай. Интересно посмотреть. Сейчас столько разных штук для техписов - на работе всё не потрогаешь.

О, если сложится, то я бы тоже послушала.
У нас инструментов минимум, и многое не пощупаешь)))

+

Да-да-да!

а что за репа, тарантуловская?

Нет, совсем песочница была где-то

Которая на гитлабе?

ну я именно на ней училась, а Лидия - не знаю

Коллеги, пишущие на английском, оцените пожалуйста такую инструкцию Хуавей. Хороша ли? Какие недостатки в ней видите? Может ли она считаться хорошим примером того, к чему стремиться пишущим на инглише?

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

мне не понравилось :)

Была бы рада поучаствовать

+

Там есть грамматические ошибки. Это надо иметь в виду. Например, отсутствие passive voice когда он должен быть и т.п. Лучше все-же для референса брать документы US- или UK-based компаний.

Навряд ли.

"You must save the configuration file before each upgrade in case some configurations that are not saved during device running are lost when the device is restarted. By default, the configuration file is stored on the hda1 by default. "

спасибо за мнения, Лекс, Эдуард, Стас!

А какие документации можно брать для референса? :)
Марина, спасибо за вопрос. Мне тоже интересно)

Ну, такие повторения у каждого не редкость :) Это когда надо сделать срочно-срочно, а времени не вычитку нет.

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

Если нужно делать классическую структуру руководства инженера, наверное можно взять за шаблон. Но вот например названия там плавают [тo doing smth. (swithing to), то просто something (xx upgrade)]. Ориентироваться будет непросто. Например: "The current system during the upgrade". Непонятно, о чём это. И по описанию тоже.

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