Size: a a a

technicalwriters

2020 August 07

MS

Maria Shabanova in technicalwriters
Constantine Drozdov
я имею в виду, что ссылка будет см. 9.1
А это делаю просто гиперссылкой
источник

MS

Maria Shabanova in technicalwriters
У нас нет печатного варианта
источник

MS

Maria Shabanova in technicalwriters
Ola Tishina
Я обычно пишу так:
"Чтобы перейти в модуль, воспользуйтесь одним из способов:
- нажмите кнопку ... на главном экране;
- нажмите клавишу ... на клавиатуре."
А так обычно делаю, если вариантов больше двух) Или если они длинные
источник

CD

Constantine Drozdov in technicalwriters
Maria Shabanova
А это делаю просто гиперссылкой
Гиперссылка имеет один недостаток - она должна указывать на конкретную редакцию пункта
источник

CD

Constantine Drozdov in technicalwriters
Нельзя, скажем, сказать "см. [defns.argument]"
источник

MS

Maria Shabanova in technicalwriters
Если есть редакция, то да)
источник

SR

Stas Rychkov in technicalwriters
Перечисление из одного пункта -- не перечисление.

Поэтому обычно так: "Для цели выполните действие".
источник

MS

Maria Shabanova in technicalwriters
В любом случае надо смотреть из последующих потребностей. Если дальше никак не предполагается использовать этот кусок, то можно никак не нумеровать
источник

CD

Constantine Drozdov in technicalwriters
Stas Rychkov
Перечисление из одного пункта -- не перечисление.

Поэтому обычно так: "Для цели выполните действие".
Вы меня убеждаете, что строка из одного символа - не строка :)
источник

SR

Stas Rychkov in technicalwriters
Constantine Drozdov
Вы меня убеждаете, что строка из одного символа - не строка :)
Конечно. Это вырожденная строка.
источник

Х

Хома in technicalwriters
Нумерация пунктов оправдывает себя, если подразумевается наличие ссылки (в ТЗ с 9 и 9.1 получается, что 9 - заголовок, а 9.1 - пункт на требования которого можно сослаться в последующем, в частности при формировании ведомости соответствия)
Как меня учил старый боевой нормоконтролер: "Нет того, что можно посчитать и не надо ссылаться? лучше не выделяй. Так можно каждое предложение выделить. Ведь ненужного текста не должно быть в документе"
источник

c

coffenot in technicalwriters
ссылки дают на нумерацию разделов, подразделов, таблиц, рисунков, но на пункты перечисления реже это требуется, сошлются на пункт подраздела, в котором этот перечнь
источник

MS

Maria Shabanova in technicalwriters
Хома
Нумерация пунктов оправдывает себя, если подразумевается наличие ссылки (в ТЗ с 9 и 9.1 получается, что 9 - заголовок, а 9.1 - пункт на требования которого можно сослаться в последующем, в частности при формировании ведомости соответствия)
Как меня учил старый боевой нормоконтролер: "Нет того, что можно посчитать и не надо ссылаться? лучше не выделяй. Так можно каждое предложение выделить. Ведь ненужного текста не должно быть в документе"
В договорах вон есть пункты из одного нумерованного пункта, для них это норма
источник

EN

Ekaterina Noskova in technicalwriters
coffenot
а вот в ТЗ частенько такое, подраздел раздела из одного абзаца нумеруется, приходилось в требованиях ТУ придерживаться подобного
9 Требования к обеспечению секретности
9.1 Требования не предъявляются
допускаю, что в гостах вполне такое может быть. но по логике, если у тебя в списке один пункт, список тебе и не нужен. точно так же нет смысла в разделе делать один подраздел
источник

Х

Хома in technicalwriters
Maria Shabanova
В договорах вон есть пункты из одного нумерованного пункта, для них это норма
ну есть и документы, где орфографические ошибки) что ж теперь
источник

c

coffenot in technicalwriters
нам нормоконтроль долго запрещала в ТУ писать какой либо текст без нумерации после текста раздела. еле отбили
источник

MS

Maria Shabanova in technicalwriters
Хома
ну есть и документы, где орфографические ошибки) что ж теперь
Ага, эти же самые договоры)) Терпеть их не могу
источник

Х

Хома in technicalwriters
Maria Shabanova
Ага, эти же самые договоры)) Терпеть их не могу
сочувствую( бесит, когда люди не умеют пользоваться вордом
источник

SR

Stas Rychkov in technicalwriters
Смысл перечисления с нумерацией -- последовательность действий. Если действие одиночное, оно описывается предложением.

Ингода делают так:

Чтобы сделать это,
         сделайте то.

С отступом. Но не смотрится.
источник

Х

Хома in technicalwriters
😳 Лучше уж жирным выделить название операции, чтоб глаза бросалось, чем такое
источник