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

 obmen_soobsheniyami.png Чат для технических писателей 
 Зарегистрируйтесь
Страницы: 1
Ответить
RSS
Средний темп работы технического писателя, Какой план (лист/час) должен делать технический писатель)
 
У нас на работе аврал, пришла новая "метла". Сейчас ставит план по объему выдаваемой техническими писателями количества листов готовой документации в день. Итак, у кого какой темп написания документации?  Есть ли какой план по разработке док-ов в неделю?.
Изменено: Ден - 20.10.2014 10:18:54 (Поторопился в выводах))
Торопливость в выводах может привести к неприятностям
 
Цитата
Ден пишет:
У нас на работе аврал, пришла новая "метла". Сейчас ставит план по объему выдаваемой техническими писателями количества листов готовой документации в день. Итак, у кого какой темп написания документации? Есть ли какой план по разработке док-ов в неделю?.
У меня - нет. Но я могу писать очень быстро :)))
techwriter.ru.com
 
говори 2-3, тогда будет время подумать над тем, что описываешь  ;)
 
обычно три листа это норма, если тема новая, так и написал
Торопливость в выводах может привести к неприятностям
 
Некоторое время назад была интересна эта тема, так как руководство было убеждено, что я пишу медленно и пребывало в четкой увереннности - то, что я делаю неделю, можно сделать за три дня.
Для сравнения медленно - это 11 страниц в день.
Так что спасибо за тему, в следующий раз буду приводить усредненные данные - 6-7 страниц в день.  
 
ГОСТ Р ИСО/МЭК 15910-2002

ПРОЦЕСС СОЗДАНИЯ ДОКУМЕНТАЦИИ ПОЛЬЗОВАТЕЛЯ ПРОГРАММНОГО СРЕДСТВА

ПРИЛОЖЕНИЕ F (справочное)

F.2 ПОМИНУТНЫЙ И ПОЧАСОВОЙ МЕТОДЫ

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

В начале проекта трудно оценить общий постраничный объем создаваемой документации. Если для завершения проекта требуется более 2 мес, подсчет страниц должен быть проведен по истечении первого месяца.

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

В таблице F.1 приведены сроки реализации «типового» (гипотетического) проекта. При этом предполагается, что автор готовит материалы непосредственно на персональном компьютере, и для их выпуска используют портативные издательские системы.

Таблица F.1 - Ориентировочные сроки
Этап Срок
Определение номенклатуры поставки16 ч на проект
Исследование содержания документации24 ч на проект
Написание плана документирования48 ч на проект
Проектирование структуры документа и правил оформления его страниц8 ч на том
Написание первой редакции (документации)1 ч на страницу
Разработка графических материалов5 ч на материал
Объединение текстовых и графических материалов30 мин на страницу
Проверка первой редакции (эксперт)30 мин на страницу
Корректировка первой редакции и графики30 мин на страницу
Внесение замечаний пользователя30 мин на страницу
Грамматическое редактирование15 мин на страницу
Подготовка второй редакции (документации)15 мин на страницу
Проверка второй редакции (эксперт)15 мин на страницу
Окончательная корректировка документации10 мин на страницу
Нормоконтроль документации15 мин на страницу
Изготовление фотошаблонов3 сут
Печать и переплетение оригиналов5 сут
Печать и брошюровка копий10 сут
Рассылка1 сут

F.3 МЕТОД НИСХОДЯЩЕГО ПРОЕКТИРОВАНИЯ

F.3.1 Общие положения

Данный метод основан на предположении, что число страниц в публикации(ях) может быть оценено достаточно просто с использованием следующих допущений:
a) автор может за месяц подготовить 22 страницы нового текста;
b) автор может за месяц подготовить 44 страницы текста с изменениями.
Например, объем публикации оценен в 150 страниц. Поскольку это новая публикация, получаем: 150/22 = 7чел./мес. В эти 7 мес. входят: планирование публикации, ее написание, редактирование и проверка двух редакций, а также подготовка фотошаблонов.

F.3.2 Пропорции
Продолжительность 7 чел./мес распределена в следующих пропорциональных отношениях:
a) 15 % - планирование (в данном примере - четыре недели);
b) 50 % - написание первой редакции (14 недель);
c) 25 % - написание второй редакции (семь недель);
d) 10 %- подготовка фотошаблонов (три недели).

F.3.3 Планирование
Период планирования охватывает:
a) исследования и подготовку плана;
b) изучение и проверку плана;
c) корректировку плана по результатам проверки.

F.3.4 Первая редакция
Период первой редакции охватывает:
a) подготовку содержания (плана-проспекта) документации;
b) изучение и проверку содержания (плана-проспекта);
c) подготовку пробного куска текста для редактора;
d) редактирование пробного куска текста и его переписывание по замечаниям редактора;
e) написание всей первой редакции документации;
f) редактирование всей первой редакции документации;
g) переработку отредактированной документации;
h) изучение и проверку переработанной документации.
Иллюстративные материалы готовят одновременно с текстом первой редакции.

F.3.5 Вторая редакция
Период второй редакции охватывает:
a) внесение в документацию всех изменений, предложенных по результатам проверки первой редакции;
b) повторное (второе)редактирование второй редакции документации;
c) переработку отредактированной документации;
d) изучение и проверку переработанной документации.

F.3.6 Принятая редакция
Редакцией для фотонабора является принятая редакция документирования. Ее подготовка охватывает:
a) внесение в документацию всех изменений, предложенных по результатам проверки второй редакции;
b) проверку правильности внесения данных изменений;
c) удаление всех редакционных разметок;
d) изготовление фотошаблонов;
e) отправку фотошаблонов в печать (в типографию)
.
Обычно экспертам (нормоконтролерам) требуется от одной до двух недель для изучения и подготовки замечаний, а сама проверка занимает от одного до нескольких дней.

Метод нисходящего проектирования может быть использован для существующих публикаций. Например, книга объемом 100 страниц может быть переработана так, что половина ее изменяется и добавляется 10 % новых материалов. Используя вышепринятые допущения, получаем: 50/44 = 1,13 чел./мес для существующего материала плюс 10/22 = 0,45 чел./мес для внесения нового материала.

Когда сроки, необходимые для создания документации, превышают допустимые, для выполнения задания следует привлекать несколько авторов. Так же следует поступать при подготовке нескольких документов для одного программного средства.
Страницы: 1
Ответить
Читают тему
Форма ответов
 
Текст сообщения*
Загрузить файл или картинкуПеретащить с помощью Drag'n'drop
Перетащите файлы
Ничего не найдено
Загрузить картинки
Отправить Отменить