Size: a a a

technicalwriters

2021 June 23

АВ

Александр Внучков... in technicalwriters
если нужно, то можно внутрь и ссылку вставить, а на сноску под таблицей якорь повесить
источник

AD

Alyona Devon in technicalwriters
вот так просто тоже странно
не динамическая документация вообще сейчас странно выглядит, параметры нельзя свернуть/развернуть

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

A

Anna in technicalwriters
Добрый день! Уважаемые коллеги, у кого-нибудь есть пример документа Спецификация оборудования по  ГОСТ 21.110-2013?  В РД 50 есть указание на то, что документ следует выполнять по этому ГОСТу. Госзаказчик упирается, требует, чтобы все соответствовало. Раньше не сталкивалась с таким гостом, помоги, пож-та, разобраться
источник

FM

Fox Mulder in technicalwriters
рд 50 отменен давным давно
источник

АД

Анастасия Дахина... in technicalwriters
это не значит, что по нему нельзя делать. замены то ему нет
источник

A

Anna in technicalwriters
Мы в курсе, заказчик тоже. но продолжает настаивать. в том-то и беда
источник

АД

Анастасия Дахина... in technicalwriters
источник

АД

Анастасия Дахина... in technicalwriters
а вообще она не прям чтобы отличается от других спецификаций, если вы делали по ЕСКД, например. Думаю, быстро разберетесь. ГОСТ на нее небольшой
источник

АД

Анастасия Дахина... in technicalwriters
рамка эта в интернете тоже скачивается
источник

A

Anna in technicalwriters
всем большое спасибо! нашла шаблон
источник

AC

Alec Chakenov in technicalwriters
Зачем делать сноску? Если информация важна настолько, что вы решили о ней рассказать, то можно прямо там же и рассказать. Новым абзацем.
источник

AD

Alyona Devon in technicalwriters
если это название в таблице, то там не поместишь
а двумя словами не назовешь
источник

AC

Alec Chakenov in technicalwriters
В вашем случае можно эту информацию разместить в вводном предложении перед таблицей.
источник

BL

Bo Larson in technicalwriters
а как думаете насколько хорошая мысль писать названия кнопок италиком? Стайлгайда нет, я его сам по сути ввожу. Мелкомягкие так вроде не пишут.

Типа - Click Withdraw вместо Click Withdraw

Есть мысль, что так удобнее читать будет, если речь об абзацах текста, а не о списках. Особенно если писать в ГДоке. И если это все указывается просто в текстовом мануале.
источник

JU

Jxhnny Ut8h in technicalwriters
я кнопки в [скобки] ставил. италик имхо читать неудобно
источник

AC

Alec Chakenov in technicalwriters
Обычно названия кнопок и полей в документации оформляются полужирным (bold font). Italics - для выделения новых терминов.
источник

BL

Bo Larson in technicalwriters
полужирным новогодняя елка получается, если много выделенных таким образом названий тем/вопросов в доке
источник

BL

Bo Larson in technicalwriters
обычно - какие-то большие ребята так делают, или это просто наблюдение на просторах интернетов?
источник

AC

Alec Chakenov in technicalwriters
Полужирным я бы не советовал больше ничего выделять.
источник

BL

Bo Larson in technicalwriters
это-то понятно, если так кнопки в тексте обозначать)
источник