Ужасное дело - писать руководство пользователя

← →
Shaman (2003-02-07 20:54) [0]

Не потому что лень, а потому, что представить не могу, как думает юзер и что нужно написать чтобы он понял. Если у кого есть какие-нибудь рекомендации по этому поводу, то, подскажите.

← →
Ketmar (2003-02-07 21:05) [1]

"аорридорный метод". выходишь в корридор, хватаешь первого попавшегося, садишь за софт и спрошаешь: "что неясно". на основе 2-3 неясно составляешь намётки мануала. чем меньше эти "первые попавшиеся" программеры, тем лучше %-))

Satanas Nobiscum! 07-Feb-XXXVIII A.S.

← →
Anatoly Podgoretsky (2003-02-07 21:07) [2]

В писатели не пригоден, это особое искуство и отдельная профессия. Но пользователем (не юзером) ты обязан быть, а если ты юзер то тебя нельзя и на милю допускать к этому делу.

← →
RV (2003-02-07 21:10) [3]

их надо любить
а то они тебя будут, регулярно

← →
mike-d (2003-02-07 21:14) [4]

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

← →
Shaman (2003-02-07 21:45) [5]

Если писать технически грамотно - употреблять слова "поле ввода", "строка состояния", "диалоговое окно", то тетя, для которой все это делается, прочитав инструкцию, дупля не сведет в программе. А когда сесть рядом, попариться часик, показать все несколько раз, объяснить самые, казалось бы, простые и всем известные истины из виндовозного интерфейса, то все ей становится ясно и работает чудесно. И когда эта тетя уже сама объясняет своей подруге, то у нее все получается за 5 минут. При этом она использует слова типа "птичечка", "значечек", "серая полосочка". Я так не умею.

← →
sniknik (2003-02-07 21:48) [6]

У нас специально человека наняли для написаний, программист на это просто физически неспособен (во всяком случае среди наших ни кому не удавалось :-)))).

← →
Ihor Osov'yak (2003-02-07 22:36) [7]

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

Но в общем то муторное дело. Если нужно написать качественно - займет много времени.

← →
GROL (2003-02-07 22:36) [8]

Да, доносить до юзера истины это искусство. Я раз в месяц отвечаю на один и тот же вопрос - где это system tray. Дошло до того я просто сделал небольшой скриншот и стрелочкой показываю где это :)

Самый простой вариант – напиши сам и дай на правку кому ни будь, не программисту, за пиво/вечер/деньгу (нужное подчеркнуть).

← →
Ihor Osov'yak (2003-02-07 22:45) [9]

> Ihor Osov"yak © (07.02.03 22:36) Южас, 6 строчек, восем ошибок/опячаток ... Но впрочем, мануалы я всегда со включенным спелчекером писал, потом не раз вычитывалось, запятые жена на место загоняла..

Зы - в школе у меня всегда по соченениям 5/3 было... Плюс русский для меня как-бы иностранный :-). Хотя после соотв. обработки (спелчекер, жена), говорят, неплохо получаалось.. Даже для публичных мест. Могу ссылочки дать..

← →
RV (2003-02-07 23:17) [10]

> Ihor Osov"yak © (07.02.03 22:45

дай

← →
RV (2003-02-07 23:21) [11]

> GROL © (07.02.03 22:36

и на дуде игрец?

← →
Ihor Osov'yak (2003-02-07 23:29) [12]

2 RV © (07.02.03 23:17)
Ладно, может за рекламу не сочтут... Тем более, для определеного круга там есть интересные вещи.. Даже продолжение собираюсь написать... Уже полтога года :-)

Использование функциональности IE
http://delphi.vitpc.com/mastering/tweb.htm

Зы. Можете расценить как прообраз мануала, чтобы совсем за оффтопик не считать...

← →
GROL (2003-02-08 01:52) [13]

Вообще, как я понимаю д.б. отдельно хелп и отдельно руководство пользователя. Второе кроме описания самих функций должно содержать примеры решения задач твоим софтом.
Причем, может с этого и начни:
Задача такая-то. Шаг 1 - делаем раз; шаг 2 – делаем два...

RV ©
> и на дуде игрец?

нет, так не умею - не на это учился :(

← →
Andrey (2003-02-08 10:27) [14]

>Shaman © (07.02.03 21:45)
>Если писать технически грамотно - употреблять
>слова "поле ввода", "строка состояния", "диалоговое
>окно", то тетя, для которой все это делается,
>прочитав инструкцию, дупля не сведет в программе.

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

>И когда эта тетя уже сама объясняет своей подруге,
>то у нее все получается за 5 минут. При этом она
>использует слова типа "птичечка", "значечек", "серая
>полосочка".

Так тоже нельзя. Потом, когда учившая тетя уволится, эта подруга позвонит тебе и начнет задавать вопросы про "птичечьки" и "серенькие полосочки" вот тогда ты пожалеешь, что сам с ней "часок не попарился" :)

Что неговори, а Ihor Osov"yak прав. Немного теории, а потом пройтись по "нажмите это и получите вот это", а потом чтоб она при тебе это сама дважды правильно сделала.

Я говорю примерно так: "Платежное поручение это документ в котором участвуют 2 организации. (конечно странно звучит, что организации участвуют в документе, но понимают, проверено на опыте :) С теорией все). Чтобы запустить программу, дважды счелкните по ярлыку. Перед вами появится список платежек. Вот в этой колонке Плательщик - это вы, а в эту вы выбираете из списка учасников Получателя....."

>Для продвинутых периодически давать мелким
>шрифтом "технические детали"

Блин, где вы этих продвинутых нашли, делитесь :)

← →
Lola (2003-02-08 11:11) [15]

Я видела несколько вакансий хэлпврайтеров, оплачиваются лучше, чем работа программиста :)

> Чтобы запустить программу, дважды щелкните по ярлыку.
:))) Я вчера в on-line дережировала таким двойным щелчком, все не получалось, раз-два, раз-два :)))

← →
Andrey (2003-02-08 11:23) [16]

>Lola
А чтобы человек научился мышкой клацать, нужно ему пасьянс косынку показать :) Серьезно, так у меня учатся бухгалтера которые первый раз за компьютер сели. И замечательно, через день они уже смело клацают где можно и где нельзя :) правда конечно и паталогические случаи попадаются (когда даже косынка непомогает :)), но это скорее исключение чем правило.

← →
JibSkeart (2003-02-08 12:18) [17]

to Andrey
ню ню именно для этого и придумали все эти игры, а точнее какойто программер для мелкософта :))

зы самое ужасное мне когда то пришлось обучать весь отдел маркетинга :-0

← →
Grrey (2003-02-08 16:25) [18]

А мне сейчас предстаит спецификацию бальшую писать. Собственно я уже начал. Но успехами не совсем доволен.
Может кто подскажет где мануал по этому поводу найти?

← →
Ihor Osov'yak (2003-02-08 16:36) [19]

> Блин, где вы этих продвинутых нашли, делитесь :)

Да находил. И среди бухгалтеров есть умные люди. Особенно, если образование техническое :-)

← →
Andrey (2003-02-08 16:48) [20]

> И среди бухгалтеров есть умные люди. Особенно, если образование
> техническое

Да уж... Я работаю в немаленькой гос. конторе, сОФТ производим :), у нас заказчики половина киевских гос. учиреждений... За 3 года, что я тут работаю объездил наверное 50-60 разных всяких бухгалтерий... И что... действительно знающих и думающих людей я видел в единственной частной конторе которая является нашим клиентом. Ужас короче... Все, ВСЕ бухгалтера в гос. конторах относятся к работе э..как к чему-то скучному, неинтересному и необязательному... Может у бугалтеров действительно такая работа, зато как от этого весело супорту вроде меня... Эх...

Естественно все это IMHO. Но недумаю, что здесь, на мастаках, найдется бухгалтер из киевской гос. конторы который меня знает и все это опротестует :)

← →
Ihor Osov'yak (2003-02-08 16:52) [21]

2 Andrey © (08.02.03 16:48)

Ну да, я не сказал, что в основном не по госсконторам бегал.. А если и были несколько - то условно государственные и довольно успешные..

Ужасное дело - писать руководство пользователя Найти похожие ветки