Разработка технической документации
Нашла недавно интересную статью Стива Колда, который некоторое время работал техническим писателем в Rational systems и GW Associates. Вот английский вариант статьи, а вот перевод на русский язык.
От себя хочу добавить то, что заметила уже давно: если действия, которые требуется совершить пользователю, являются неочевидными, а их перечисление
занимает несколько страниц текста с поясняющими скриншотами, картинками и схемами, то через пару релизов ПО интерфейс упрощается и описывать его
становится одно удовольствие.
Я согласна с автором статьи: документация не должна покрывать недостатки ПО. Но иногда случается так, что необходимо срочно выпустить промежуточный релиз, и руководство, естественно, должно ему соответствовать. Тогда от описания возможных непростых взаимодействий пользователя и системы никуда не деться.
В этом, на мой взгляд, и состоит задача технического писателя: несмотря на наличие сложных алгоритмов так составить описание, чтобы оно было понятным, информативным и полезным для пользователя.