Я отвечу из своего опыта подготовки документов по 34 ГОСТу.
В среднем я на один документ закладываю пару дней плотной безотрывной работы (это при условии наличия у меня ВСЕЙ необходимой информации по проекту). Это будет первая итерация документов, к которой заказчик может давать замечания в зависимости от своей фантазии. С учетом того, что замечаний по существу документа как правило нет, и они носят характер: "запятая не того цвета" - длительность стадии "улучшений" предугадать не получится.
Вам совершенно правильно сказали, что срок написания документов напрямую зависит от сложности самой программы. Если у Вас простенькая программулина - то такого срока вполне достаточно. Если это сложная программа в которой 150 отчетов, которые нужно описать как формировать - то конечно это мало.
Кроме того на время подготовки документов влияет:
-ваша скорость печати,
-быстродействие вашего компа (если вы между окнами по 5 минут переключаетесь, то можно долго писать);
-скорость работы той программы, которую вы собрались описывать;
-ваши навыки работы с описываемой программой ( если вы ей хорошо пользуетесь, то вы быстро опишите, если вы первый раз с ней работаете - то можете описать или неправильно (потому что не всё бывает очевидно) и потратите время на её изучение)
- ваше владение сопутствующими программками (снять скриншот, что-то обвести в графическом редакторе и т.д и т.п.).
+ в настройках файла поставьте автосохранение: у меня стоит 1 минута и я этого не замечаю. Если при каждом сохранении у вас все зависает минут на дцать... то... В общем: все должно летать
).
Если тупо взять тз, поменять в нем слово "должно быть " на "сделано", "разработано" - то пояснительная записка будет готова за несколько часов. Не ведитесь на автозамену - может поменять там, где не ждете.
Лучше через F5: и по подсвеченным словам пройтись.
Но по поводу пояснительной записки: там внутри есть несколько крупных разделов, которые иногда выносят в отдельные документы: описание автоматизированных функций, описание информационного обеспечения и описание ктс. (Это как раз к вопросу о техпроекте: у нас это записка, описание по, описание информ обеспечения и описание автоматизированных функций, описание комплекса технических средств. В ГОСт конечно документов больше - но заказчик хочет так).
Описание автоматизированных функций: если вы будет писать в ключе, что пользователь нажал туда-то, программа сделала то-то - это одно.
Если от вас требуется писать в ключе, что пользователь нажал туда-то , сформировался запрос такой (пример строки запроса), в этом запросе содержатся такие-то параметры (перечень параметров и какой для чего нужен), запрос передается в базу данных, в результате возвращается ответ вида (пример строки ответа) - то лучше обратиться к программисту. Сделайте ему пример описания функции - и потом получившийся результат вставите в документ.Как правило - они работают в каком-нибудь опенофисе или либерофисе. Заложите время на перенос текста из документа в документ. Можно сделать копию с Word документа и отдать, но у моих коллег эти опенофисы, так портят вордовский документ, что на форматирование уходит дикое кол-во времени. Проще перенести.
Для информационного обеспечения: наверняка Вам понадобится перечень таблиц из Бд, перечень полей и их описание и т.п. - такие вещи Вам тоже могут подготовить коллеги (администратор БД, например), пока вы готовите другие документы. (ну если у вас хорошие отношения со всеми.)
Описание КТС: если нужно быстро, то тоже можно формально заменить какой-то схемой, перечнем серверов и т.п. - если есть архитектор (в худшем варианте сисадмин) - можно попросить у него. Наверняка такая информация есть, в каком виде- это уже другой вопрос.
Описание ПО: ну тут тоже если это формальный подход, то заполняете гостовый документ: из тз, переносите все, что можете заполнить, смотрите- какую информацию вам могут выдать программисты, в конце концов некоторые туда листинг вставляют.
Время написания хорошего руководства пользователя с картинками и подписями к ним - зависит в том числе и от количества картинок в нем. В среднем на то, чтоб вставить одну картинку ( сделать скриншот, вставить в руководство, подписать её и сделать на неё ссылку в тексте через перекрестную ссылку) - у меня уходит от 30 секунд до минуты. Опять же в зависимости от того каким инструментом для снятия скриншота Вы пользуетесь и сколько картинок вы хотите вставить (потому что тогда список картинок в перекрестной ссылке увеличивается и на выбор нужной ссылки тоже тратятся секунды) + быстродействие вашего компьютера.
Если Вы нажимаете PrintScreen и потом картинку обрезаете в Word - значит еще больше времени.Если сразу обрезаете нужную область (например,я пользуюсь Greenshot или ABBYY Screenshot Reader) - то быстрее.
Если у вас в руководстве 100 картинок- то это уже как минимум полтора часа на то, чтоб просто вставить картинки в документ,подписать их и сделать ссылку в тексте ( Я имею ввиду следующую ссылку: "...схема расположения оборудования представлена на рисунке ниже, Рисунок 1".).
Если программист параллельно с вами меняет интерфейс программы - можно заработать нервный срыв
))
Накидываете время на то, если Вы на этих картинках еще что-то будете обводить ( ну например обвести кнопку на которую нажать и т.п.).
Поэтому когда надо быстро- жертвуйте картинками.
Само руководство: если у вас все работает и вы можете воспроизвести все действия пользователя- это одно время, если что-то ломается и Вы какую-то функцию не можете описать - другое.
Руководство админа: попросите выдать вам все характеристики рабочего места администратора - можно запросить у админа (ну или у разработчика, у тестера, смотря кто у вас там есть, кто устанавливал программу, настраивал её и т.п.)- в общем нужно посмотреть, какую информацию вам могут выдать заранее, а Вы её потом вставите в документацию и "причешете". Картинки: будете иллюстрировать каждый шаг - увеличиваете время подготовки документа. Тут еще такой момент: как правило, если кто-то вам устанавливает программу, то он очень быстро проскакивает все стадии установки- и вы остаетесь без картинок. Придется что-то повторять.
Желательно всегда писать про то, как проверить работоспособность установленной программы, и привести перечень сообщений которые может выдавать программа в случае ошибок и т.п. Тоже спрашивайте у программиста: учитываются ли у тебя какие-то ошибки, если- да как они обрабатываются, какое сообщение выдается на экран ( и выдается ли вообще). Если не выдается : пишите, что в случае неработоспособности обратитесь к системному администратору.
Программа и методика: ну полдня - день. Опять же от подробности документа зависит. От самого ТЗ конечно тоже: 3 функции там, или 133.
Частично программу и методику можно передрать из руководства пользователя, если проверяются какие-то пользовательские функции.
Объем Вы сами регулируете. Например в ТЗ у вас есть требование: "пользователь должен иметь возможность отправить письмо с несколькими вложенными файлами".
Вы можете написать:
Шаг 1:пользователь нажимает туда-то - открывается окно почты + картинка
Шаг 2:Пользователь нажимает туда-то, открывается окно для выбора файлов+картинка
Шаг 3:Пользователь нажимает туда-то, активируется инструмент прикрепления файлов+картинка
Шаг 4:Пользователь удерживает Shift и выбирает несколько файлов и т.д. и т.п.
А можете короче: пользователь открыл окно почты и с помощью инструмента-такого-то (вставляете маленькую картинку кнопки прям в предложение) прикрепляет нужные файлы , удерживая клавишу Shift нажатой.
Учитывайте, что обычно в ходе предварительных испытаний, возникают какие-то замечания. Поэтому лучше заранее обсудить с руководством, что вы будет вписывать в эти замечания ( как правило одно-два для приличия придется вписать). Или подойдите к программисту спросите: какие были косяки и как их исправили (конечно, это должно быть что-то простое). Но на это тоже нужно время: от "сразу" до нескольких часов. Хорошо если ведется трекер ошибок- он быстрее освежает память.
Программа опытной эксплуатации довольно-таки быстро трансформируется из программы предварительной (при наличии готовой предварительной - пару-тройку часов). Главное не мудрить с табличками (чем больше ячеек наобъединяете, тем сложнее потом что-то безболезненно выдрать из этой таблицы). Нумеруйте строки таблицы не в ручную, тогда при удалении строк, они перенумеруются автоматически.
В любом случае, прежде чем кидаться писать - изучите документы, посмотрите, какая информация может вам понадобиться и какую информацию Вы можете получить у своих коллег. Заранее озадачьте их, поставьте срок, с учетом того, что вам нужно это все еще обработать потом. Им тоже нужно время, чтоб подготовить информацию для вас.
Акт сдачи-приемки выполненных работ готовит как правило бухгалтерия. Иногда: неправильно.Иногда проще самим подготовить, так как в акт надо перенести РЕЗУЛЬТАТЫ работ из ТЗ. Но не у всех получается правильно перенести текст из одного документа в другой с первого раза.
И не забыть еще напомнить секретарю - чтоб сделали сопроводительное письмо, на то,что вы передаете заказчику. Тоже лучше список выдать, что будете передавать.А то всякое бывает....
ну вот как-то много у меня получилось текста... может быть что-то полезное всё-таки в нем есть
))
чат для технических писателей в Telegram
