Клуб технических писателей

июль 2014
Technical Writing 101: как правильно оценить сроки
Пономарева Вера
7 июля 2014, 12:36
Начинаем серию постов-обуждений книжки Technical Writing 101, написанной американскими авторами Alan S. Pringle и Sarah S. O'Keefe.
В ней есть как общие сведения для начинающих: из чего состоит профессия техписа, как обычно устроен рабочий процесс, с какими трудностями предстоит столкнуться, так и конкретные советы для более опытных профессионалов.

 

 

В этом посте поговорим о том, как оценить сроки выполнения работы.
Важная особенность профессии состоит в том, что техпис в основном работает самостоятельно. В больших компаниях можно использовать существующую схему работы и инструменты. Но часто вы можете оказаться единственным техписом в команде или вообще фрилансером. Организация процесса полностью ложится на ваши плечи.
А начинается всё с планирования.
«Возможно, вам захочется приступить к работе сразу, не тратя время на составление планов, однако именно планирование и анализ являются ключом к написанию хорошего документа.»
Как заранее оценить сроки выполнения задачи? Даже опытный документатор не может в точности предсказать, сколько дней уйдет на написание документа:

 

«В составлении планов есть что-то от черной магии, что, однако, не должно удерживать вас от этого занятия. Используйте оценки в качестве ориентира.»

 

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

Формула, предлагаемая авторами:

1 задача, выполняемая пользователем = 2 страницы

 

1 страница = 8 рабочих часов

 

То есть, умножаем количество пользовательских задач на 16 и получаем количество часов.
Дополнительно надо учесть "отягчающие" факторы, такие как сложность продукта или многочисленность изменений. В целом, придерживайтесь старого доброго принципа "Обещай меньше, делай больше!", советуют авторы.
Наверняка у каждого из вас есть приемы или формулы, позволяющие оценить временные затраты на написание документа. Давайте обсудим их в комментариях!

 

Описание книги на сайте издательства: http://www.scriptorium.com/books/#tw101.

5 комментариев
Technical Writing 101,почитать,яндекс,рецепты
Посоветуйте, пожалуйста, как убедить аналитика
panasta
10 июля 2014, 14:30

Коллеги, добрый день!

 

Пишем систему управления инженерными данными для проектировщиков (подробнее тут).
Подразумевается, что пользователи системы работают с компьютером не на продвинутом уровне. И вроде бы ничего не противоречило этому, пока в контекстном меню не появилась команда под названием Монтировать. Причем без уточнения, что и куда. Раньше эта команда называлась Исходные файлы проекта.

Дело в том, что исходные файлы проектов хранятся на виртуальном диске. И, чтобы его не загромождать, папки проектов появляются на диске только по требованию.

Мне кажется, что слово не слишком уместно в данном контексте и для нашей аудитории не подходит вовсе. Уговаривала аналитика поменять. Он со мной согласился, но потом вернул его на место.

 

Как вы думаете, можно ли вообще употреблять такие узкоспециализированные (в данном контексте) слова в ПО для обычных пользователей?

Если вы согласны со мной, как вы думаете, как можно положительно повлиять на ситуацию?

 

4 комментария