Size: a a a

technicalwriters

2021 February 24

AL

Alla Lu in technicalwriters
А Ш
Подскажите пожалуйста, если в нормативно-правовом акте введены сокращения, нужно ли их повторно вводить в приложении к нему?
На тему оформления НПА нашел только ГОСТ Р 6.30-2003 Унифицированные системы документации. Унифицированная система организационно-распорядительной документации. Требования к оформлению документов
В этом ГОСТ (как и в других ГОСТ оформления документов, которые я смотрел) данный вопрос не затрагивается.
ГОСТ не  действующий, заменен на ГОСТ Р 7.0.97-2016
источник

AL

Alla Lu in technicalwriters
А Ш
А есть на что сослаться в качестве обоснования?
Пример (ГОСТ 1.5-2001, так же в ГОСТ 7.32-2001):
"3.12.1 Материал, дополняющий основную часть стандарта, оформляют в виде приложений. ...
3.12.7 Приложения должны иметь общую с основной частью стандарта сквозную нумерацию страниц."

Нумерация общая, документ един, список сокращений один
источник

АШ

А Ш in technicalwriters
Спасибо за помощь.
При этом правильно ли я предполагаю, что в названии приложения нужно писать целиком, не сокращая?
источник

МК

Марина Ковалева... in technicalwriters
если сокращение общепринятое из гост, то можно его использовать и в названии
иначе смотрела бы по ситуации
источник

AL

Alla Lu in technicalwriters
А Ш
Спасибо за помощь.
При этом правильно ли я предполагаю, что в названии приложения нужно писать целиком, не сокращая?
В заголовках не рекомендуется приводить сокращений. На ваше усмотрение
Часто пишут как в ГОСТ 1.5-2001:
3.6.16 В заголовке межгосударственного стандарта не рекомендуется использовать сокращения, римские цифры, математические знаки, греческие буквы. Допускается использование буквенных, цифровых и буквенно-цифровых сокращений, входящих в условные обозначения продукции, единиц величин, общепризнанных аббревиатур, кодов и т.п.
источник

VW

Vinni Winterlight in technicalwriters
Имя(обязательно)
Коллеги, такой вопрос :
Есть ли изменения в ГОСТах 19, 34, 2, 25 на 2021год?
В двойке есть.  Меняют 2.105-2019. Были противоречия по обязательным шрифтам (внутри проприетарка была).  Полный список изменений скорее всего можно на docs.cntd посмотреть.
источник
2021 February 25

KC

Kseniya Chudakova in technicalwriters
Всем привет! Присоединяйтесь сегодня к ланчу в 13:00 МСК
источник

KC

Kseniya Chudakova in technicalwriters
источник

KC

Kseniya Chudakova in technicalwriters
Комната открыта 🐻
источник

АК

Анна Крыжановская... in technicalwriters
Любопытная вещь: инструкция в конституции (я мимокрокодил, а вот ссылка: http://www.lawcommission.gov.np/en/archives/821)
источник

AV

Anastasia Voronova in technicalwriters
Коллеги, подскажите, в титульном листе ЧТЗ кол-во листов указывается с учетом приложений к документу или без? И указывается ли вообще?
источник

AL

Alla Lu in technicalwriters
Anastasia Voronova
Коллеги, подскажите, в титульном листе ЧТЗ кол-во листов указывается с учетом приложений к документу или без? И указывается ли вообще?
Смотря по какому ГОСТ оформляется. Если по ЕСПД, то как обычно - общее количество листов всего документа. Приложения - часть документа и имеет сквозную нумерацию с основной частью
источник

AV

Anastasia Voronova in technicalwriters
Спасибо!
источник

АШ

А Ш in technicalwriters
Помогите пожалуйста разобраться.
Согласно п. 40 Разъяснений, утв. Приказом Минюста № 105, нормативные правовые акты могут содержать ссылки на официально опубликованные национальные стандарты и информационно-технические справочники.
Нужно дать ссылки на ряд ГОСТ, но по утверждению юристов они не опубликованы и соответственно ссылки на них дать не могу. Стандарты указаны как действующие, но пытался найти их официальное опубликование - и не нашел.
Как быть?
источник

VW

Vinni Winterlight in technicalwriters
А Ш
Помогите пожалуйста разобраться.
Согласно п. 40 Разъяснений, утв. Приказом Минюста № 105, нормативные правовые акты могут содержать ссылки на официально опубликованные национальные стандарты и информационно-технические справочники.
Нужно дать ссылки на ряд ГОСТ, но по утверждению юристов они не опубликованы и соответственно ссылки на них дать не могу. Стандарты указаны как действующие, но пытался найти их официальное опубликование - и не нашел.
Как быть?
complete.
источник

ET

Eduard Tibet in technicalwriters
Кстати, для начинающих TWR в этом чате. Помню, тут были такие, кто интересовался: с чего начать. Тут обучение предполагается быть и оно бесплатно. Налетай! :) https://russia-students.ru/form/intel-technical-writing-school5
источник

ДМ

Денис Минеев... in technicalwriters
Eduard Tibet
Кстати, для начинающих TWR в этом чате. Помню, тут были такие, кто интересовался: с чего начать. Тут обучение предполагается быть и оно бесплатно. Налетай! :) https://russia-students.ru/form/intel-technical-writing-school5
Гранмерси!
источник

AL

Alla Lu in technicalwriters
А Ш
Помогите пожалуйста разобраться.
Согласно п. 40 Разъяснений, утв. Приказом Минюста № 105, нормативные правовые акты могут содержать ссылки на официально опубликованные национальные стандарты и информационно-технические справочники.
Нужно дать ссылки на ряд ГОСТ, но по утверждению юристов они не опубликованы и соответственно ссылки на них дать не могу. Стандарты указаны как действующие, но пытался найти их официальное опубликование - и не нашел.
Как быть?
Вам нужны ресурсы, где можно найти официальные данные по ГОСТ?
источник

АШ

А Ш in technicalwriters
Alla Lu
Вам нужны ресурсы, где можно найти официальные данные по ГОСТ?
мне нужно разобраться, как правильно ссылаться на ГОСТ в НПА
источник

AN

Alexey Naumenko in technicalwriters
Семён Факторович
Мы тут посовещались админской коллегией и решили ввести пару новых правил чата.

Нам поднадоели постоянные разговоры про «один стандарт документирования хуже другого» и «всюду ГОСТ и честным людям жизни нет».

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

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

— российских ГОСТов или других стандартов документирования;
— специалистов, работающих в разных областях нашей профессии и с разными документационными стандартами;
— зарплат в разных областях наших профессии.

Единичное нарушение этого запрета влечет за собой предупреждение, повторное — бан на длинный срок.


✅ Можно:
— «Я не могу разобраться в требованиях к документу Х из ГОСТ 34, ответьте мне на пару вопросов по ним, пожалуйста»
— «Какова средняя зарплатная вилка ГОСТ-техписателя в России?»
— «Куда мне лучше расти — в DocOps-инженера или документатора API?»
— «В среднем англопишущий документатор API зарабатывает больше ГОСТ-техписателя» (это объективный факт рынка труда)


❌ Нельзя:
— «Документационный стандарт Х бесполезен и никому не нужен»
— «Техписатели, использующие документационный стандарт Х, получают в 10 раз меньше остальных и умрут в нищете»
— «Документы с рамочками — атавизм, все, кто их пишут — дураки и не лечатся»
— «Пользовательская документация — тупиковая ветвь профессионального роста, все крутые чуваки и чувихи пишут только OpenAPI в сваггере за 300кк/сек»
Друзья, а уместно ли в этом чате опубликовать вакансию для технического писателя? (мы разработчики PostgreSQL / Pro)
источник