Help`ы. Крик души

← →
Катерина © (2002-07-10 12:23) [0]

Иногда на разработку справочной информации: хелпы, инструкции, описания, уходит столько же времени, сколько и на создание программы. Причем все это происходит примерно по такому алгоритму: ставится задача, определяю сроки с учетом хелпов, пишу. Программа работает, делаю инструкции. Заказчик ходит кругами и ноет:
-Ну дай, ну ведь уже работает.
-Нет инструкции.
-Ну покажи основное, я разберусь. Очень надо. Работа стоит и т.д.
Ну ладно, думаю, пусть поработает, пока я хелпы делаю. Может какие огрехи всплывут, замечания. Заодно исправлю. Предупреждаю:
-Опытная эксплуатация!
Устанавливаю одному пользователю, второму... Третий приходит и заявляет:
-Ты уже закончила с задачей...
-Нет. Еще хелпов нет и...
-Ерунда, программа работает, инструкции потом напишешь. Срочно надо написать программу и т.д.
Пишу следующую задачу, потом еще одну и еще. Ненаписанные инструкции копятся. В конце концов наступает кризис (например, я собираюсь в отпуск):
-Пиши инструкции!
Пишу. Приходят пользователи.
-Ты пишешь: "...сделать активным окно...". Это как?
Посылаю к ликбезу по WINDOWS.
-А нельзя слово "окно" заменить на "табличка". Нет, ты напиши, какую кнопку за какой нажимать... И т.д., т.д., т.д.

Я думаю многие проходили через это. Конечно, уважающий себя программист писать хелпов не будет, а если и напишет, то не снисходя до уровня пользователя. Но к сожалению мы работаем среди них и для них. И условия диктуют тоже они. Поэтому поделитесь: как вы создаете справочную информацию, сколько времени на это уходит? На какой уровень ориентируетесь? Может быть имеет смысл писать хелпы одновременно с программой. Или до? Тема очень больная, т.к. через 10 дней - в отпуск, а безхелпных программ накопилось аж 6 штук.

← →
besa © (2002-07-10 12:56) [1]

2 Катерина ©
На какой уровень ориентируетесь?
на уровень пользователя_два_дня_как_за_компом(специфика такая, текучка кадров)
в соответстви с этим и времени уходит вагон, т.к. приходиться разжевывать прописные истины
с другой стороны приятно почитать грамотный хелп (написаный тобой же :))) )

твой крик души очень даже понимаю и сочувствую

← →
VAleksey © (2002-07-10 13:09) [2]

к сожалению все как ты пишешь :(

← →
Игорь Шевченко © (2002-07-10 13:32) [3]

Катерина © (10.07.02 12:23)

:-) Сочувствую

Вообще-то help должен писать технический писатель, если он есть...В сотрудничестве с программистом. У нас так.

← →
Катерина © (2002-07-10 13:43) [4]

>>Игорь Шевченко ©
У нас даже такой должности нет. В лучшем случае программисту дают техника(ов). Но последних постоянно отвлекают на другие работы. Так что я даже и не знаю, есть ли у меня еще техник или уже окончательно забрали. Последний раз мы что-то писали вместе 1.5 года назад.

← →
Mike B. © (2002-07-10 15:35) [5]

>> Катерина ©
Help me! I"m in the HELLp!!!

← →
Катерина © (2002-07-10 16:20) [6]

>>Mike B. ©
>>Help me! I"m in the HELLp!!!
Если HELL, то это мольба не ко мне, а если нет, то я не знаю английского.

← →
Островской (2002-07-10 18:19) [7]

Катерина!
Вы - наш луч света в темном царстве!

← →
RV © (2002-07-10 18:23) [8]

Удалено модератором

Хелп надо писать вместе с прогой.
Вкрайнем случае можно скинуть в html все черновые записи если таковые имеются.

← →
Леха_ (2002-07-10 18:50) [10]

хелп должен писать технический писатель заодно во время написания хелпа он находит немалое количество ошибок

если ж его нет :-( то надо вовремя писать хелпы а на все вопли что ты еще не приступил к следующей задаче объяснять что еще не завершил эту

← →
Torry (2002-07-10 23:42) [11]

Есть такой инструмент, не идеальный, но отслеживающий изменения кода, называется Doc-O-Matic ( http://www.doc-o-matic.com).

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

Кстати, какие форматы хелпов вы предпочитаете: PDF, HTML или
Windows Help? И почему?

Help`ы. Крик души Найти похожие ветки