Всё для технического документирования
+7 (495) 001-40-42
Разработка технической документации
Курсы для технических писателей
Программное обеспечение

Советы техническим писателям: Документирование изменений в пользовательском интерфейсе в небольших командах

10.06.2013

Muhtar Kent, Nathan DealТехническим писателям часто приходится описывать пользовательские интерфейсы различных программных приложений. При этом разработка приложений не стоит на месте, имеет циклический характер, и поэтому важно выработать правильную стратегию работы для того, чтобы не случалось авралов или, хуже того, срывов сроков. Крейг Кардимон, технический писатель, работающий в таком активном режиме, делится своими советами.


Пользовательский интерфейс изменяется так же быстро, как песок под ногами, когда вы находитесь на пляже близко к береговой линии, и на него находят сильные волны. Ощущения очень похожие. Сейчас вы стоите твёрдо на своих ногах. А в следующий момент вы теряете баланс и ищете точку равновесия. Позвольте поделиться с вами несколькими советами, следуя которым можно остаться на ногах в круговороте документирования небольшого интернет-магазина с быстро меняющимся ассортиментом.

1. Узнайте крайний срок выполнения работы – он раньше, чем вы думаете. Первый вопрос, который я задаю: «Когда крайний срок сдачи работы?» Это простой, но обманчивый вопрос. Люди могут записать дату, но не осознавать, что она означает. Например, 7 октября 2011 года. Это первая пятница октября. Если бы это была дата крайнего срока вашей работы, вы можете подумать: «Вау, у меня есть время до октября, чтобы это сделать! Куча времени». Сейчас ещё сентябрь, и следующий месяц может казаться гораздо дальше, чем он на самом деле, пока вы не запишете эту дату. Какой бы календарь вы не использовали, бумажный или цифровой, убедитесь в том, что вы записали эти даты.

2. Подтвердите то, что конкретно необходимо сделать. Сразу же за вопросом «когда» следует вопрос «что». Если кому-то требуется документ в формате Word, PDF или веб-формате, я знаю, что смогу это сделать, и, по всей вероятности, вы тоже сможете. Правда, время от времени клиент может кинуть вам кручёный мяч, запросив в качестве конечного продукта то, о чём вы знаете мало – возможно, MP3 или Flash. Решите, сможете ли вы обучиться требуемому достаточно быстро, чтобы дать клиенту то, что он хочет. Вы можете даже спросить их, почему им нужен именно этот специфический формат и, если это имеет смысл, предложить альтернативу.

3. Устанавливайте контакты с ответственными лицами. Иногда сотрудник, с которым я контактирую по заказу – мой начальник, но чем больше он занят, тем больше делегирует свои функции другим сотрудникам. Так что я не всегда уверен в том, что знаю, кто является моим контактом для какого-либо проекта, пока не спрошу. Особенно важно разрешить этот вопрос во время сезона отпусков, когда ваш основной контакт может отсутствовать в офисе, когда вам нужно что-то сделать. Убедитесь в том, что вы знаете также, кто ваш второй контакт.

4. Не пренебрегайте мелким подкупом. Программисты – тоже люди, и от большинства людей можно получить отклик, если использовать правильную компенсацию. Вы найдёте общий язык с разработчиками, используя их пристрастие к сладкому или зависимость от кофеина. Банка со сладостями, стоящая на вашем столе – открытое приглашение. Периодически посещайте их комнаты с вкусняшками из «Старбакса» или с упаковкой колы на всех. Независимо от того, что получите взамен, убедитесь, что вы персонально предложили что-то разработчикам, и убедите зайти к вам, чтобы обсудить грядущие изменения. Это пригодится, когда крайний срок выполнения работы будет близок, и вам потребуется оперативная помощь.

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

Источник: Tips & Tricks: Small Teams and Documenting a Changing UI

Тэги: ,

< Вернуться к списку публикаций

Облако тегов