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

 obmen_soobsheniyami.png Чат для технических писателей 
 Зарегистрируйтесь
Страницы: 1
RSS
подскажите по обозначению
 
Есть в руках документ под названием "Руководство системного программиста" и обозначен вот так:
"ЯАКЖ.00005-01 32 02".
Как "читать" такое обозначение?
По какому стандарту обозначен?
"32" -- это скорее всего код, что именно "Руководство системного программиста"
А вот где редакция, подредакция, вариант и т.п. (как точнее?)?
И что могут обозначать "ЯАКЖ", "00005"?
 
Код организации-разработчика  
Код классификационной характеристики системы
Регистрационный номер                    


32 это номер документа, а 02- его версия
Быть или не быть?
 
Нашел еще документ с ЯАКЖ:
[url:2s8735xd]http://primets.ru/netcat_files/userfiles/Files/YaAKZh.426485.001%20RE(i2).pdf[/url:2s8735xd].
У вас - документ организации ООО «ПраймТехноСистемс»?
Если у вас появятся вопросы, пожалуйста, обращайтесь - будем думать вместе!
 
Цитата
Есть в руках документ под названием "Руководство системного программиста" и обозначен вот так:
"ЯАКЖ.00005-01 32 02".
Как "читать" такое обозначение?
По какому стандарту обозначен?
"32" -- это скорее всего код, что именно "Руководство системного программиста"
А вот где редакция, подредакция, вариант и т.п. (как точнее?)?
И что могут обозначать "ЯАКЖ", "00005"?


[b:1l9s4yll]ЯАКЖ[/b:1l9s4yll] - Код организации разработчика (код регистрируется официально, уже где-то обсудалось где,кем и как).
[b:1l9s4yll].00005[/b:1l9s4yll] - Порядковый номер программного изделия в классификаторе организации разработчика. Классификатор тоже имеет ГОСТ на его ведение (прошнорованы/пронумеровани...).
[b:1l9s4yll]-01[/b:1l9s4yll] - Версия программного изделя (сертифицированная версия, а не промежуточная, которую делаю разработчики каждый день).
[b:1l9s4yll]32[/b:1l9s4yll] - Код вида документа (32- руководство системного программиста).
[b:1l9s4yll]02[/b:1l9s4yll] - версия документа

еще может добавляться - ЛУ и -П1 (П2,П3,П4....)

[b:1l9s4yll]-ЛУ[/b:1l9s4yll] - лист утверждения
[b:1l9s4yll]-П1[/b:1l9s4yll] - приложение 1
 
Вот еще из семейного архива ))
 
Это по ЕСПД. "Номер издания программы или номер редакции документа  
присваивают в порядке возрастания с 01 до 99." Если документ на программу, то "номер издания программы", т.е. можно версию программы вида "02".
Но тогда где редакция самого документа?
В ЕСПД структура видимо немножко иная?
 
Цитата
Это по ЕСПД. "Номер издания программы или номер редакции документа  
присваивают в порядке возрастания с 01 до 99." Если документ на программу, то "номер издания программы", т.е. можно версию программы вида "02".
Но тогда где редакция самого документа?
В ЕСПД структура видимо немножко иная?
Редакция документа должна совпадать с номером издания программы (версией). Не может быть так, что у вас программа версии -78, а документ относящийся к нему -79.
Даже если много изменений в документе, все они фиксируются в листе изменений. Когда выйдет новая версия программы, тогда будет и новая редакция документа.

Если новую версию программы решат перерегистрировать, то пятизначное число станет +1, а номер издания "обнулится" на 01 (соответственно и редакция документа станет 01). И тогда это  юридически будет считаться отдельным продуктом.


Цитата
В ЕСПД структура видимо немножко иная?
Такая же.
 
То есть, до выхода новой версии программы, улучшения в программе описываются, но только "копятся" в промежуточной версии документа.
И даже если улучшения "косметического" характера и касаются исключительно документа (а программа не меняется).
 
Цитата
То есть, до выхода новой версии программы, улучшения в программе описываются, но только "копятся" в промежуточной версии документа.
Не в промежуточной, а в той же самой версии документа, с отражением изменений в списке изменений. "Промежуточная" или черновик она для вас, а для отчетности это готовый документ. Например, переименование одной кнопки в программе. Так и пишете в листе изменений "15.02.2013. Изменено название кнопки [b:2syyf989][Ок][/b:2syyf989] на [b:2syyf989][ОК][/b:2syyf989] в разделе 1.2.3. Заменена иллюстрация 2.2".

Теоретически, тот кто будет смотреть документ сможет понять, что в программе 12345 версии 01 есть такой-то функционал. 15.02.2013 было внесено изменение в программу (без изменения версии) , что зафиксировано в документе.
Но практически, я уверен, что это никто это не будет читать, т.к. всем пофигу когда что изменялось в программе. А пользователям совершенно не нужна документация, оформленная по ГОСТ. :mrgreen:

Цитата
И даже если улучшения "косметического" характера и касаются исключительно документа (а программа не меняется).
Такие изменения не нужно фиксировать, это не касается программы.

Я надеюсь, вы не будете писать в листе изменений, что вы изменили лист изменений???  :mrgreen:
 
Вот у меня изменилось название раздела. Захотел заменить "устаревшее" "Конфигурирование программы" на "Настройки для программы".
 
Цитата
Вот у меня изменилось название раздела. Захотел заменить "устаревшее" "Конфигурирование программы" на "Настройки для программы".
Требований отражать это в списке изменений я не слышал и не стал бы вносить, т.к. это зря потраченной время и дополнительная путаница, в первую очередь для себя. А вот ссылки на этот раздел в других документах надо бы проверить, чтобы не оказалось " см. в п.1.2.3 "Конфигурирование программы", которого на самом деле нет ни в оглавлении, ни в документе.
 
Цитата
Требований отражать это в списке изменений я не слышал и не стал бы вносить, т.к. это зря потраченной время и дополнительная путаница, в первую очередь для себя. А вот ссылки на этот раздел в других документах надо бы проверить, чтобы не оказалось " см. в п.1.2.3 "Конфигурирование программы", которого на самом деле нет ни в оглавлении, ни в документе.
Да, вполне аргументированный ответ!
 
Цитата
ADVANCED пишет:

Теоретически, тот кто будет смотреть документ сможет понять, что в программе 12345 версии 01 есть такой-то функционал. 15.02.2013 было внесено изменение в программу (без изменения версии) , что зафиксировано в документе.
Такие вещи зависят от того, как на предприятии организовано управление конфигурацией программного обеспечения.
Внесение изменения в программу без изменения версии - прямая дорога в хаос.

Как Вы будете отслеживать внесенные изменения? По какому документу?
Как минимум - внесенное изменение должно быть оттестировано(проверено).
Т.е.  должны где-то остаться следы -  как проверяли, кто проверял, успешна ли проверка.  
И как Вы будете это фиксировать?

8)  Насчет "пофигу" - опять же зависит от специфики.
Не верю, что Вам как пользователю, пофиг какие изменения в Word вносятся от версии к версии.
 
Цитата
'''' --- пишет:
Внесение изменения в программу без изменения версии - прямая дорога в хаос.
Если ваше руководство будет отстегивать за лицензирование каждой версии ОГО-ГО какую круглую сумму и уйму времени, то про хаос вы не вспомните.

Цитата
'''' --- пишет:
Т.е. должны где-то остаться следы - как проверяли, кто проверял, успешна ли проверка.
Багтрекеры
Системы управления версиями
Системы управления проектами
Системы управления жизненными циклами разработки и еще куча всего.
Изменено: 'ADVANCED' - 03.04.2013 22:39:51
 
Цитата
'ADVANCED' пишет:
Если ваше руководство будет отстегивать за лицензирование каждой версии ОГО-ГО какую круглую сумму и уйму времени, то про хаос вы не вспомните.

Багтрекеры
Системы управления версиями
Системы управления проектами
Системы управления жизненными циклами разработки и еще куча всего.
Ясно. Т.е. документация выпускаемая весьма и весьма косвенно связана с положением дел.

Программисты и тестировщики - сами по себе со своими версиями, и системами управления.
Тех. писатель - сам по себе, со своими собственными версиями.

ПыСы.  Я делаю документацию для сертифицированного ПО.  Где официальный ввод версии тоже не прост.
Но предпочитаю максимально избегать подобных вариантов.
 
Цитата
ADVANCED пишет:
еще может добавляться - ЛУ и -П1 (П2,П3,П4....)
ADVANCED, скажите, пожалуйста - в каком ГОСТе указывается такое обозначение (-П1) отдельных приложений? Для меня это актуально, хотя нигде этого не встречала   :oops:
 
34.201-89
 
'ADVANCED', в ГОСТ 34.201-89 регламентируются обозначения документов на системы, а обозначения вида "ЯАКЖ.00005-01 32 02" - программные и описываются они по ГОСТ 19.101-77 и 19.103-77.
Поэтому в  ГОСТ 34.201-89 точно быть не может вот этого:
Цитата
ADVANCED пишет:
еще может добавляться - ЛУ и -П1 (П2,П3,П4....)
А вот то самое "-П1", на которое вы сослались в ГОСТ 34.201-89 на самом деле не обозначение приложения к программному документу, а код документа "Пояснительная записка к эскизному проекту".


P.S. Ах, 'ADVANCED'... как Вам не стыдно - наводить тень на плетень?
Изменено: KLen - 13.06.2013 13:35:15
 
Доброго времени суток!
Почитал и хотелось бы немного поправить... :)
ЯАКЖ.00005-01 32 02 - неверная запись обозначения документа, даже согласно 19.103-77.
Должно быть: RU.ЯАКЖ.00005-01 32 02
Так как программный продукт не может работать без вычислительной системы, то это уже программно-технический комплекс автоматизированной системы (ГОСТ 34.003-90), соответственно, может быть и по ГОСТ 34.201-89 (п.3 Обозначения документов), но это обозначение уже будет выглядеть так (к примеру): ЯАКЖ.502120.005.И3.02

P.S. Обычно, при разработке документации первым делом (после ТЗ и ПЗ) создаю "Руководство пользователя" по 34 ГОСТ (И3), а уже затем руководство оператора(пользователя, RU.ЯАКЖ.00005-01 34 01), системного программиста(администратора, RU.ЯАКЖ.00005-01 32 01) и программиста(разработчика, RU.ЯАКЖ.00005-01 33 01), на создание которых при готовом ИЗ уходит порядка 10 минут (H&M).
 
Цитата
'H&M User' пишет:
на создание которых при готовом ИЗ уходит порядка 10 минут (H&M)
И вы серьезно думаете, что заказчику нужен будет весь этот комплект "макулатуры"?
 
Цитата
KLen пишет:
И вы серьезно думаете, что заказчику нужен будет весь этот комплект "макулатуры"?
Именно. Госзаказчик никогда не примет этап без нее...
 
А нужен для ТЗ номер? И, если нужен, то какой номер для ТЗ правильный, ведь ГОСТ 19.101-77 не даёт код вида документа?
Например:

RU.09445927.425530-03 ТЗ 01
RU.09445927.425530-03 90 01

Какой из них правильный?
 
Цитата
Дмитрий пишет:
А нужен для ТЗ номер? И, если нужен, то какой номер для ТЗ правильный, ведь ГОСТ 19.101-77 не даёт код вида документа?
Например:

RU.09445927.425530-03 ТЗ 01
RU.09445927.425530-03 90 01

Какой из них правильный?
Цитата
На ТЗ не дают децимального номера.
Изменено: Ialo - 14.01.2014 15:36:43
 
А если наоборот изменилась версия программы, но на документе никак это не сказалось, исправлять ничего не пришлось. Нужно ли менять версию документа?  
 
Я считаю, что версия программы (или документации на нее) должна меняться исключительно при появлении параллелей, скажем, добавилась какая то новая функция, тогда у нас появляется RU.АБВГ.00001-02, но при этом RU.АБВГ.00001-01 остается жизнеспособным. Это особенно критично, если при разработке требуется сертификация ПО, т.к. в сертификатах в явном виде прописываются обозначения ПО.
Если закапываться в нормоконтроль и архив, то изменение программы (кода) определяет изменение документа "Текст программы" АБВГ.00001-01 12, который (слепо следуя требованиям ЕСПД, что приветствуется у госзаказчиков) должен выглядеть как исходный код на бумаге (своего рода тоже документ).
Страницы: 1
Читают тему