Разработка технической документации и технические писатели Технические писатели и разработка технической документации технические писатели в Телеграм 

 obmen_soobsheniyami.png Чат для технических писателей 
 Зарегистрируйтесь
Страницы: 1
Ответить
RSS
ГОСТ или корпоративные стандарты
 
Вы склоняетесь к использованию ГОСТ или корпоративных стандартов в работе? лично я начал видеть лишним четкое соответствие документации ГОСТу, так как все они созданы для 80х годов. Я думаю, их можно придерживаться, но зачем все до мелких подробностей соблюдать? Рамки, правильные названия исполнителей и тп.
 
у меня стойкая неприязнь к ГОСТам, это атавизм, который за собой несут крупные госучреждения (МинОбороны, МВД и т.д), кроме этого соблюдение ГОСтам кормит армию нормоконтролеров. Абсолютно устаревшее оформление документов, тьфу на них.
Торопливость в выводах может привести к неприятностям
 
Согласно Закону "О техническом регулировании", от 27.12.2002 N 184-ФЗ,
стандарт (в том числе и ГОСТ) — документ, в котором в целях добровольного многократного использования устанавливаются характеристики продукции, правила осуществления и характеристики

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

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

ГОСТ Р ИСО 15910-2002 Процесс создания документации пользователя программного средства
ГОСТ Р ИСО 12207-2010 Процессы жизненного цикла программных средств
ГОСТ Р ИСО 15288-2005 Процессы жизненного цикла систем
ГОСТ Р 53622-2009 Информационные технологии. Информационно-вычислительные системы. Стадии и этапы жизненного цикла, виды и комплектность документов
ГОСТ Р ИСО/МЭК 20000-1-2013 Информационная технология. Управление услугами. Часть 1.
ГОСТ Р 52292-2004 Информационная технология. Электронный обмен информацией. Термины и определения
ГОСТ Р 53624-2009 Информационные технологии. Информационно-вычислительные системы. Программное обеспечение. Системы менеджмента качества. Требования
ГОСТ Р ИСО 14764-2002 Сопровождение программных средств
ГОСТ Р ИСО 15489-2007 Управление документами, общие требования
ГОСТ Р ИСО 27001-2006 Системы менеджмента информационной безопасности. Требования
и т.д.

Также очень много ценного имеется в стандартах ISO и IEEE. Например, по пользовательской документации я бы обратил внимание на стандарты:
ISO 26514-2008 - Requirements for designers and developers of user documentation
ISO 26511-2012 - Requirements for managers of user documentation
ISO 26512-2011 - Requirements for acquirers and suppliers of user documentation
ISO 15289-2015 - Content of life-cycle information products (documentation)
 
Цитата
Виктор Фигурнов написал:
Согласно Закону "О техническом регулировании", от 27.12.2002 N 184-ФЗ,
 стандарт (в том числе и ГОСТ)  — документ, в котором   в целях добровольного многократного использования   устанавливаются характеристики продукции, правила осуществления и характеристики
Виктор спасибо! Теперь будет на что ссылаться, если будут требовать соблюдение ГОСТ. Даже не знал о таком законе. Иногда бесит, когда заказчик просит сделать по ГОСту документацию на програмульку, использующуюся в каком нибудь андройдном приложени.И за полезные ГОСТы тоже спасибо!
Торопливость в выводах может привести к неприятностям
 
Цитата
Ден написал:
Цитата
Теперь будет на что ссылаться, если будут требовать соблюдение ГОСТ. Даже не знал о таком законе.
Учтите, что кроме ГОСТов, есть еще технические регламенты. https://ru.wikipedia.org/wiki/%D0%A2%D0%B5%D1%85%D0%BD%D0%B8%D1%87%D0%B5%D1%81%D0­%BA%D0%B8%D0%B9_%D1...
Соблюдение технических регламентов обязательно. Многие технические регламенты содержат требования к документации.
Если объект, по которому создается документация, подпадает под действие какого-то технического регламента, то требования к документации этого регламента придется целиком и полностью выполнять.
 
Цитата
Ден написал:
у меня стойкая неприязнь к ГОСТам, это атавизм, который за собой несут крупные госучреждения (МинОбороны, МВД и т.д), кроме этого соблюдение ГОСтам кормит армию нормоконтролеров. Абсолютно устаревшее оформление документов, тьфу на них.
Мыслите шире.
Чтобы принять какую-то работу, надо сначала предъявить требования к этой работе (ТТХ, ТЗ, ТУ и др.).
Так вот, такими требованиями и являются ГОСТы для серьезных учреждений. Они кратко запишут - разработать документы на ПО согласно ГОСТ 19 серии.
Вы
их разрабатываете и сдаете. Если есть некие претензии со стороны
заказчика, смотрите в ГОСТ - кто прав, если заказчик - исправляете
согласно ГОСТ, если Вы - указываете на это заказчику. В любом споре (в
том числе и в суде) вы сможете доказать, что претензии заказчика
неправомочны. И вы получите причитающееся...
А если ни каких
требований вы с заказчиком не обговаривали, то и принимать у вас он
может хоть сто лет, требуя править каждый параграф...
Со стороны подрядчика тоже есть плюсы: заранее известно КАКИЕ документы, КАК делать, ЧТО в них должно быть. Да только эти знания сократят ваше время написания "в разы"!
И,
кстати, нормоконтролер - это тот "незамыленный" глаз, который все
"плюхи" техписа выявит и либо поправит, либо укажет на них, чтобы сам
поправил. Ну а для проектировщиков он тоже много чего полезного сделает... Но об этом не на сайте техписов...  :-)
Удачи!
 
Цитата
''ivs0'' написал:
Цитата
такими требованиями и являются ГОСТы для серьезных учреждений. Они кратко запишут - разработать документы на ПО согласно ГОСТ 19 серии.
И как же ГОСТЫ 19 серии, разработанные в 1978-1980 гг.,  помогут сделать современную, высокоэффективную, конкурентоспособную программную систему?

1978-80 гг. это применительно к IT-технологиям все равно что каменный век по отношению к современным промышленным технологиям.

1978-80 гг. это эпоха больших компьютеров типа ЕС ЭВМ, БЭСМ-6, и т.п., перфокарт, магнитных лент, распечаток на АЦПУ и т.д.

Тогда даже пользователей у программ не было. Были программисты, системные программисты и операторы. Что и отражено в названиях и содержании документов ГОСТ 19 серии.

Программисты писали программы, сами или с помощью соответствующей службы наносили программы на перфокарты или перфоленты, отдавали колоды перфокарт сотрудникам вычислительного центра, там операторы согласно инструкции запускали считывание колод перфокарт, ставили магнитные ленты или диски (один диск размером примерно 45х45х30 см имел емкость 29 Мбайт и устанавливался в дисковод размером с невысокий холодильник), получали распечатки и отдавали их программистам. А системные программисты обслуживали вычислительные центры, чтобы они хоть как-то работали.

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

Польза от документов того времени не более чем от трудов средневековых алхимиков.

Наверное, Google, IBM, Yandex, и сотни тысяч других крупнейших фирм разработчиков несерьезные учреждения, ибо не применяют и никогда не будут применять ГОСТ 19 или 34 серии.  
 
Хотел бы отметить, что ГОСТ 19 серии приняты в 1978-80 гг, а разрабатывались начиная с 1973 года. Т.е. они отражают реалии 1960-х - начала 1970 гг.
 
Цитата
Гость написал:
Цитата
''ivs0''   написал:
Цитата
такими требованиями и являются ГОСТы для серьезных учреждений. Они кратко запишут - разработать документы на ПО согласно ГОСТ 19 серии.
И как же ГОСТЫ 19 серии, разработанные в 1978-1980 гг.,  помогут сделать современную, высокоэффективную, конкурентоспособную программную систему?

Вы бы хоть поглядели на эти ГОСТы. :-)
ГОСТ 19 серии содержат требования не к программе, а к документации на программу. А хорошую программу делают с помощью аналитиков, изучивших потребность автоматизации и подготовивших качественное ТЗ,  и умений программистов (хотя это уже не факт - есть ПО, которое прямо из диаграмм процессов делает базу и интерфейс для пользователей, но здесь не об этом...). А вот составить качественные документы  по уже разработанной программе - это ГОСТ 19 серии. А чем определяется качество? Правильно - требованиями. А кто к документам предъявил требования - правильно - заказчик. Заказчик предложил вам свой стандарт по разработке документов? Отлично - пишите по его стандарту и сдавайте работу. Заказчик не предложил? Тогда как проверить качество? Вот для этого есть ГОСТ. Если "коробочная" программа - ГОСТ Р ИСО 9127-94.  И по нему же принимаем.
Если заказная и заказчик не предъявил требований к документации (или указал, что документы надо делать по ГОСТ19), то разрабатываем документы по 19 ГОСТ, и приемку документов осуществляем по этому ГОСТ.
 
Цитата
''ivs0'' написал:
А вот составить качественные документы по уже разработанной программе - это ГОСТ 19 серии. А чем определяется качество? Правильно - требованиями. А кто к документам предъявил требования - правильно - заказчик.
Не путайте качество и соблюдение требований заказчика.
О том что такое качество программного обеспечения и каковы критерии его оценки, см. например стандарт ISO 25010-2011

Цитата
''ivs0'' написал:
Заказчик не предложил? Тогда как проверить качество? Вот для этого есть ГОСТ.
Как ГОСТ 1977-1980 г., написанные для совершенно иных реалий, могут использоваться для проверки качества документации на современные информационные системы? Например, вам надо написать документацию на онлайн-сервис, в его разработке, установке, эксплуатации, обновлении задействованы многие десятки людей разных специальностей. Для которых надо подготавливать отдельные документы, о которых ничего не говорится в ГОСТах 19 серии. А персонажей из реалий 1970--х гг., для которых ГОСТЫ 19 серии предписывают писать руководства, сейчас вообще не существует. Даже если какие-то люди имеют те же названия должностей, они сейчас выполняют совсем не те функции, которые предполагаются в ГОСТах 1970-х гг.

Цитата
''ivs0'' написал:
Если "коробочная" программа - ГОСТ Р ИСО 9127-94.
ГОСТ Р ИСО 9127-94. это перевод давно отмененного стандарта ISO 9127-1988, 1988 года. Сейчас действует стандарт ISO 26514-2008.

Цитата
'ivs0'' написал:
приемку документов осуществляем по этому ГОСТ.
И получаете такие "ценные документы", как "Формуляр", "Руководство системного программиста", "Руководство программиста", "Руководство оператора", "Описание языка" и пр.

Если ГОСТы серии 19 имеют какую-то ценность, то почему Google, Apple, Microsoft и прочие крупнейшие фирмы разработчики их не применяют? :)

Вам не кажется, что требование применения ГОСТов 1970-х гг. к современной IT-продукции, в корне отличающейся от того, что было в 1970-е годы, это вредительство и путь к отсталости навсегда?
Изменено: Виктор Фигурнов - 09.07.2015 12:55:38
Страницы: 1
Ответить
Читают тему
Форма ответов
 
Текст сообщения*
Загрузить файл или картинкуПеретащить с помощью Drag'n'drop
Перетащите файлы
Ничего не найдено
Загрузить файлы
Отправить Отменить