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

 obmen_soobsheniyami.png Чат для технических писателей 
 Зарегистрируйтесь
Страницы: 1
RSS
Новый госконтракт, Подготовка к новому госконтракту
 
Как я уже писала в одной теме - я новичок.

В компании будут заключать новый госконтракт на развитие ППО. Будет много документов: ДПЗ, ЧТЗ, Описание ПО, Руководства пользователя и т.д. Часть документов будет браться из предыдущих госконтрактов.

Но как лучше подготовится к данному процессу, чтобы улучшить создаваемую документацию? Как лучше спланировать свои шаги, свою работу? Помоги, подскажите.
 
Если Вы имеете в виду внешнюю документацию (документацию, предоставляемую пользователям/заказчикам программного обеспечения), то стандарты ISO/IEC/IEEE на разработку такой документации рекомендуют определить требования к документации, составить и согласовать спецификацию на подготавливаемую документацию и техническое задание на подготовку документации. Затем, на их основе, составляются план документирования и план управления документированием  Процессы определения требований к документации, составления спецификации и технического задания на подготовку документации подробно освещены в стандарте ISO/IEC/IEEE 26512:2011 Systems and software engineering — Requirements for acquirers and suppliers of user documentation, а процессы составления плана документирования и плана управления документированием — в стандарте ISO/IEC/IEEE 26511:2011 Systems and software engineering. Requirements for managers of user documentation. Разумеется, при составлении этих планов, ТЗ, спецификации, должны учитываться целевая аудитория, требования к стоимости и времени работ, имеющиеся ресурсы, квалификация исполнителей и т.д., о чем также написано в указанных стандартах.  
 
Администратор, удалите, пожалуйста тему. Я хочу ее пересоздать под своим ником.
 
Админ, не удаляйте тему, никак незалогиниться на ваш форум.

Виктор, нет, вы слишком глубоко поняли мой вопрос.

Примерное ТЗ уже есть.
На основании требований к документированию по ГК будут составляться документы.

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

Как корректно налаживают данный процесс? Как правильнее? Не знаю, изучить там, например, до конца все ГОСТы, составить шаблоны документов, разобрать что нового появилось в разрабатываемом ППО и т.д. Я конечно, понимаю, что скорее всего эта не та компания в которой меня научат...но надо с чего-то начинать...
 
Здравствуйте.
Новый контракт как правило еще месяца полтора будет подписываться (т.е. после того как выиграете- еще будут долго подписывать).
Не закладывайтесь на дату подписания контракта.  Не думайте, что вот сейчас подпишут и тогда приступите к работе.
Иногда- волшебным образом- срок первого этапа резко меняется с 3-х месяцев до 2-х недель.

Кстати... обычно перед контрактом еще предложения к тз нужно делать, это тоже работа на пару-тройку дней. Если не делали - спросите менеджера. Может вам их нужно делать?

Так как ТЗ еще пока примерное: то смысла пока что-то писать нет.  Если тз пишете не вы (а если вы тем более) -  то оценивайте то, что вы написали, с точки зрения того как вы потом будете демонстрировать, что достигнут нужный результат. Или вообще достигнут. Сильной конкретики не нужно.

Займитесь подготовкой шаблонов. Если это продолжение старого контракта, то нужно взять старые документы,скопировать и  почистить их .
Кому-то удобно все удалить (оставив только заголовки), кому-то удобно оставлять текст и потом уже удалять (ну чтоб было понимание, что вообще писать).
Таким образом вы будете понимать, какое наполнение будет в разделах  и какая дополнительная информация   от технических специалистов вам может понадобится.
Например: описании информационного обеспечения может понадобится схема БД, лучше предупредить заранее, что она будет нужна. (Специально ее никто не делает, как показывает практика.). После подготовки такой "рыбы"  становится видно какой документ с каким будет перекликаться.
Для новичка- это важно.
Т.е. вы уже будете представлять какие части из какого документа можно "дернуть".

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

Как только узнаете что выиграли контракт- сразу приступайте к чистовой подготовке документов.
Кто у вас отвечает за этот контракт? Менеджер? Юрист? Подойдите, спросите- когда будут результаты конкурса.
Как узнаете примерную дату- то начиная с этого числа- ходите и спрашиваете какой результат.

Далее, как только выиграете...

Имея на руках утвержденное  ТЗ, вы уже можете заполнить часть пояснительной записки и прочих документов.

При этом вы должны мониторить дату подписания контракта, не оставляйте это на откуп менеджеру.
В моей практике был случай (в самом начале), когда меня не уведомили о том что контракт подписан, и сообщили об этом- та-а-да-ам!!- в день окончания первого этапа! Слава Богу, там  не было документов, только акты и дистрибутив. Все доки были во втором этапе. Но на них был отведено 2 месяца, а уложиться пришлось в один.Было обидно.

Так что постоянно интересуетесь- подписали ли контракт.
Как только узнаете дату подписания контракта, берете ТЗ ( и если у вас поэтапная сдача особенно) - сами просчитываете все даты.
За дату отсчета берете не день подписания контракта, а следующий за ним.Это будет первый день первого этапа. Считаете даты.
Внимательно смотрите в ГК (да скан ГК у вас должен быть!! как правило техпису его не дают, думают, что не нужен- но он вам нужен. Там сроки сдачи прописаны.): скорее всего по ГК документы вы должны сдать на 5-7 дней раньше окончания  этапа (для согласования).

Составляете такой список (числа для примера):
16.02.2016 - передача документов на согласование
20.02.2016 - окончание этапа, подписание актов

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

Вот с каким нюансами сталкиваюсь постоянно я:

1) Госзаказчик  за дату окончания этапа берет не ту дату , которая стоит в ТЗ, а ту - когда вы фактически сдали документы.

Например -окончание первого этапа у вас 20.02.2016.
Скорее всего в ГК будет написано, что сдать документы вы должны на 5-7 дней раньше  т.е. 15.02.2016.

Допустим второй этап у вас- 20 дней. Вот эти 20 дней они могут считать от 16.02.2016 (т.е. от штампа на сопроводительном письме).

Эти 20 дней (если бы вы считали от 20.02.2016) наступили бы 11.03.2016 года (считаем в календарных днях).
Опять же так как вы должны  за пять дней раньше сдать  - это было бы 07.03.2016.

Но....так как заказчик будет считать от 16.02.2016 (от даты передачи документов по первому этапу),  то смотрим, что мы получаем: 07.03.2016 -это 20 дней. Минус 5 дней - 02.03.2016. Вот это будет ваша дата сдачи документов по второму этапу ( а не 07.03.2016).


2) Если срок сдачи выпадает на субботу например. У нормальных людей в этом случае сроком сдачи считается первый рабочий день- т.е. понедельник. Госзаказчик может (и скорее всего потребует сдать в пятницу) - вот вам еще три дня "съестся" и соответственно сдвинется срок следующего этапа.

Т.е. ваша задача - помимо написания документов- следить за сроками, чтобы не было просрочки.
И пусть даже у вас документы будут с ошибками/опечатками- все равно отправляйте- чтобы не сорвать сроки. Пока они будут проверять неделю, а то и больше- исправите.

Поэтому: просчитываете сроки и отправляете их заказчику. Потом вешаете у себя перед компом этот список и мониторите даты.

Еще учтите: что если у вас будут испытания, то программу и методику вы должны сдать ДО испытаний, чтоб её утвердили.
Как нам объясняли: нельзя приходить на испытания с не утвержденной методикой.

Т.е. например:  испытания у вас на третьем этапе. Пусть окончание третьего этапа будет 20 марта. Это значит - что к 20 марта испытания должны быть успешно пройдены. Т.е. сами испытания должны быть где-то 15-17 марта, а программу и методику вы должны отправить с сопроводительным письмом ДО испытаний (т.е. хотя бы за 3-5 дней).  Я пишу по своей практике- может у кого-то по другому, но у нас вот так. Эти сроки тоже нужно учесть, хотя бы примерно. Потому что ПМИ - как правило - объемный документ.  Его тоже можно заранее подготовить : таблицу, выписать пункты ТЗ туда.

Если будет обучение: например перед опытной эксплуатацией. То обучение люди должны пройти ДО начала опытной эксплуатации. У вас например, может быть в третьем этапе документ "Программа обучения персонала". Но сдавать вы её будете не 20 марта, а гораздо раньше.
Т.е. вам надо понять хотя бы примерные сроки проведения опытной эксплуатации, и программу обучения предоставить заранее, с учетом того, что еще неделю   нужно на обучение заложить. И... чтоб к моменту начала опытной эксплуатации было зафиксировано, что люди обучение прошли.

Если у вас есть ЧТЗ  и ТЗ: как писать программу и методику испытаний? Нам аудит заказчика так и не дал на это ответ.
Писали и по ТЗ, и по ЧТЗ: т.е. была колонка "пункт по ТЗ" и "пункт по ЧТЗ".
Поэтому старайтесь  максимально сохранить похожесть.
Т.е. если в ЧТЗ будут все те же самые пункты что и в ТЗ, только более расширенное описание- это не страшно.
Но когда в ЧТЗ появятся доп. пункты: ну например у вас в ТЗ был пункт"Функции веб-приложения" (например), в а ЧТЗ будет пункт "Функции веб-приложения" и подпункт: Функция "Отображение веб-карты", Функция "Перемещение по веб-карте" и т.п., то вот тут у вас пункты совпадут, а подпункты в ТЗ нет, так что учитывайте это при написании ЧТЗ. Сильно не мудрите.

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

Нужно хорошо сделать программу и методику предварительных испытаний.
Опять же: не мудрите с таблицами, колонками и т.п.
Вам ее потом копировать в протокол, там какие-то столбцы придется удалять. Если будет много объединений ячеек- это будет сложно сделать.

Потом вы эту программу и методики скопируете еще раз и сделаете из неё программу и методику приемочных испытаний и протокол приемочных. Так что потратьте время на написание методики предварительных испытаний (этим документом вы фактически закроете еще 3 документа)

Ну в общем я думаю, надо начать с подготовки шаблонов документов и проработки сроков (когда будет известна дата подписания контракта).

Параллельно с подготовкой шаблонов выписывайте, какие-то вопросы: если вам понадобится какая-то дополнительная информация, схемы там, список файлов и т.п. вы должны понимать, что   люди вам тоже за 5 секунд эту информацию не выдадут.
Т.е. им нужно заранее сказать, что вот для такого-то документа мне будут нужна такая-то информация. Нужна вот к такому-то числу (число называете с запасом) - вам же еще перенести надо в чистовой документ, иногда удается скопировать, а иногда и все перенабирать приходится.

Если у вас разработка ПО: вам будет потом нужно описание дистрибутива. Тоже позаботьтесь заранее: программистам надо еще его собрать будет. У нас например до недели уходит на это процесс.

Вот как-то так.
 
Для начала почитайте "азы" по жизненному - циклу ПО: ГОСТ Р ИСО/МЭК 12207-2010,ГОСТ Р ИСО/МЭК ТО 15271-2002
и по процессу создания пользовательской документации ГОСТ Р ИСО МЕК 15910-2002.
Скорее всего у вас заказная разработка (для ГК чаще всего) - для правильного оформления и "наполнения" документов вам нужно изучить ГОСТ 19 серии.
Но если у вас коробочный продукт, то для такого ПО есть специальный ГОСТ Р ИСО 9127-94.
На первое время этого достаточно.
 
Цитата
ovin написал:
Админ, не удаляйте тему, никак незалогиниться на ваш форум.
Вы можете отписаться здесь, в чем проблема и почему не получается залогинится
Страницы: 1
Читают тему