Чтобы не затягивать в долгий ящик обсуждение, можно сказать, что

Question

TechWriters.ru - technical writers (технические писатели)

Чтобы не затягивать в долгий ящик обсуждение, можно сказать, что

никаких требований по ГОСТ в реальности не существует. Это некая такая гражданская договоренность, которую люди сами на себя берут из каких-то мотиваций.

Соответственно, создавший документацию не по ГОСТ (например, я сторонник документации для пользователя в комиксах, как в руководствах на самолеты в США во время Второй мировой), то ему никаких претензий от кого-то не последует? Ну если таких требований не содержат какие-то еще документы (например, по обязательной сертификации).

Верно?

0

09.11.2023

14 ответов

13 просмотров

Мечтают ли электровеники об электроовцах?

Стикер

0

6 месяцев назад

Ekaterina Krasiuk

после развала СССР госты стали рекомендательными так что да, верно но если ты подписываешься что ты соответствуешь этим "рекомендательным мерам", то должен подтвердить (это как раз сертификация)

0

6 месяцев назад

Aleksey Spiridonov Автор вопроса

Boris Ugarov
не совсем. ГОСТы не запрещают давать информацию в ...

Интересно, спасибо.

0

6 месяцев назад

Ekaterina Krasiuk

Boris Ugarov
не совсем. ГОСТы не запрещают давать информацию в ...

но кроме того ты должен привести содержание, аннотацию, список сокращений....

0

6 месяцев назад

Aleksey Spiridonov Автор вопроса

Ekaterina Krasiuk
после развала СССР госты стали рекомендательными т...

Ну не вижу я пока в документах по сертификации упоминаний, что нужно писать документацию по ГОСТ. Попытался найти ее где-то выше, глобальнее - спросил в том числе у вас. В принципе я уже могу сказать - я там вот в той комнате посмотрел.

0

6 месяцев назад

Ekaterina Krasiuk

Aleksey Spiridonov
Ну не вижу я пока в документах по сертификации упо...

если требования нет значит вам не надо подтверждать ему соответствие значит не обязательно писать по госту)

0

6 месяцев назад

Boris Ugarov

Aleksey Spiridonov
Интересно, спасибо.

возможно у вас некое предубеждение, что ГОСТ это обязательно некий "академический" стиль написания текста, стрёмные рисунки из paint'а и т.п. совсем нет: документы по ГОСТу могут быть очень даже "радующими взор и слух". попробуйте рассматривать ГОСТ как перечень вопросов, которые нужно раскрыть в документе. Если какие-то разделы кажутся ненужными - уберите. опять же, случай из моей практики: заказчик просто ненавидел ГОСТы, даже слышать о них не хотел, приходилось врать, что док не по ГОСТу, хотя я делал по ГОСТу, но не строго. в один момент всё поменялось и стало нужно "строго по ГОСТу, б??ть!!!!!!!!!!" - мы немного подкрутили док, добавили пару дурных разделов и всё стало норм

0

6 месяцев назад

Aleksey Spiridonov Автор вопроса

Ekaterina Krasiuk
если требования нет значит вам не надо подтверждат...

Я немного с авиации, но той что летают для себя самого и не возит людей. У нас тут просто четкая такая штука - делай только то что обязан, а что не обязан делай если это реально полезно. Вот я и выясняю в этом ключе, откуда вылезло это требование. И пример для развлечения. Российские авиационные чиновники в целях забюрокрачивания любят ГОСТы - приносишь им формуляр на маленький самолет или планер (формуляр это типа дневника воздушного судна). А они тебе говорят - "не по ГОСТ". и не то что им ГОСТ нужен, просто они тебя нахрен хотят послать и им нужен повод. Ты им говоришь, а где написано по ГОСТ? Нигде? Так вот не требуйте. Или все же делаешь как они говорят - так как спорить порой сложно. А почему не делаешь по ГОСТ, потому что за границей где выпустили аппарат - никаких гостов нет и книжечка формуляра там просто такой блокнотик с произвольными по сути полями (и бывает даже что в этой книжечке ни одной печати синей). А формат формуляра по русскому ГОСТ он делался из расчета что в мире существуют только огромные многодвигательные самолеты. Т.е. для мелкой шушлайки формат по ГОСТ бред.

0

6 месяцев назад

Медведь

Aleksey Spiridonov
Я немного с авиации, но той что летают для себя са...

Добрый день! Вы глубоко ошибаетесь. И мне кажется вы хотите услышать от кого-то ответ , что ГОСТы не нужны и хотите это аргументировать. Раньше например когда выпускали изделия, были болты и гайки разных размеров, потом пришли к единому понимаю, что нужно делать их одинаковыми и сразу всем стало жить легче. Почему никого не смущает что синтаксис языка при программировании, должен быть написан только так и не иначе, потому что по другому работать не будет. Почему не смущает ,что машину нужно заправить например только 95 бензином, иначе двигателю плохо будет. Возьмём например опенсорсные библиотеки, в них есть ряд лицензий по которым используются эти в библиотеках, скажем в комерческих или не комерческих проектах и например их выкладывают на гит хабе и указывают их, а у нас в стране например регулирует это ГК РФ (авторское право). И например приходят куча документов, сотни и тысячи во ФСТЭК и быстрее и понятнее их будет обрабатывать по установленному стандарту или шаблону, чтобы увеличить эффективность и пользу и время обработки и рассмотрение данной документации. Какие это подходы конечно устарели, но где то новые разработаны , а где то нет. Повторюсь, вы скорее всего ищите аргументированный ответ (почему по ГОСТ делать не надо). И если углубляться возьмите для примера хотя бы протоколы сетей, чтобы будет если каждый будет использовать свои? Или возьмите кодировку UTF 8, можно перечислять долго.

0

6 месяцев назад

Aleksey Spiridonov Автор вопроса

Медведь
Добрый день! Вы глубоко ошибаетесь. И мне кажет...

Абсолютно верно меня поняли. Аргументированный ответ. Ощущения мне не нужны. При этом я не хочу и не буду спорить с теми, кто считает что ГОСТ это некая сознательная необходимость - типа неписанного правила. Я пришел не спорить с "гостовцами". И если я ищу повод не делать по ГОСТ это не значит, что ГОСТ плохой. Я просто не хочу чтобы мой хороший знакомый получил не то что он реально хочет и нуждается и охладел к вопросу. Кроме того, заказчик не интересуется моим мнением - как надо делать. И вопрос не стоит, а как бы сделать. Вернее, я ему ответил что я хочу. Но это вызвало не самый радостный отклик - я попросил автогенерацию скриншотов, которые генерились бы с некими различными dummy-данными и некими пользовательскими данными-конфигами. А также учет при генерации всех платформ и различных типов терминалов, а также учет разных локалей (чтобы с разными языками интерфейса генерить скриншоты). А также развертывания всего что нужно для docs-as-code силами его девопса. Вот это меня волнует. Но не то чтобы он обязательно захотел ГОСТ. :-)

0

6 месяцев назад

Luiza

Aleksey Spiridonov
Абсолютно верно меня поняли. Аргументированный отв...

А вы сами спланируйте, что и в каком объёме будете описывать и разрабатывать, может это и окажется в итоге по мотивам ГОСТ. Тут каждый второй приходит и спрашивает, а как описать архитектуру, а как описать программу? А какое содержание, а какой минимум, чтобы это описать, вот ГОСТ это лишний раз просто помощник какое может быть содержание как минимум

0

6 месяцев назад

Алиса Селезнева

Luiza
А вы сами спланируйте, что и в каком объёме будете...

Стопудово. Эти вопросы возникают у тех, кто не читал ГОСТОв

0

6 месяцев назад

Missclick Очепятка

Aleksey Spiridonov
Я немного с авиации, но той что летают для себя са...

Смотри ГОСТ не обязателен. Однако скорее всего ваша фирма имеет сертификат исо9600. Это значит что ваша фирма разработала систему менеджмента качества(стандарт предприятия) В которой прописана в какой форме вы делаете документы. По ГОСТ, или по SRS, или АS1000D и тд. Вот прокурор как раз может наложить штраф если вы не сделаете по требованию. Или сертифицирующий орган может отобрать сертификат. А без него будет невозможно либо затруднительно заключать договора. Так же в гос.корпорациях есть понятие аудита. Честно я не знаю чем он регламентирован. Но Роскосмос, Алмаз-Антей, Росатом и ещё пара фирм могут проводить аудит вашей документации на соответствие ГОСТ. И ты либо устраняешь замечания либо каждый год платишь штраф. Мы за 4 года обычно снимаем большинство замечаний на оставшиеся пишем объяснительные. Что касается сертификации отечественной вычислительной техники и СПО, то для попадания в реестр не требуется ГОСТ. У них есть чёткие требования. Но какая нибудь баба Маша может не пропустить так как не по ГОСТ и она не знает как ей выполнять свою функцию. И вы долго будете в ручном режиме всем объяснять как надо делать. Да и сертификация СЗИ тоже не требует ГОСТ. Лаборатория даёт опросный лист(анкету) лишь для унификации и стандартизации процессов. Эдуарт Успенский в свой книге школа клонов поясняет для чего это надо.

0

5 месяцев назад

Boris Ugarov · Accepted Answer

не совсем. ГОСТы не запрещают давать информацию в виде комиксов. Можно сделать комиксы, несколько слайдов комикса, располагаемых на одной странице подписать рисунок номер такой-то, а перед ними сказать: программа функционирует как показан на рисунках номер адын - номер икс, приведенных ниже. И это будет вполне себе "по ГОСТу"

Похожие чаты

Чтобы не затягивать в долгий ящик обсуждение, можно сказать, что

14 ответов

Похожие вопросы