Ненавижу писать хелп на свои проги,... :-(((

← →
WondeRu © (2004-08-20 11:52) [0]

...но заставляют! Предложения типа "нажмите на это, чтобы появилось то... затем нажмите на другое..." коробят меня!!! Постоянное повторение одних и тех же слов!(((

← →
Игорь Шевченко © (2004-08-20 11:54) [1]

> Ненавижу писать хелп на свои проги

Правильно, лучше сразу в корзину.

← →
Соловьев © (2004-08-20 11:54) [2]

Вроде в ТеХ есть такая фича, что по коментариям пишет документацию при компиляции. Но вроде под линух и под С

← →
Ega23 © (2004-08-20 11:55) [3]

Соловьев © (20.08.04 11:54) [2]

... и на английском... :о)

← →
Игорь Шевченко © (2004-08-20 11:57) [4]

Real Programmers don"t write specs.
Users should be grateful for whatever they get:
They are lucky to get any programs at all.

← →
Соловьев © (2004-08-20 11:57) [5]

> [3] Ega23 © (20.08.04 11:55)

я серезно, когда-то читал... :)

← →
reticon © (2004-08-20 12:06) [6]

>> "нажмите на это, чтобы появилось то... затем нажмите на другое..."

а что, юзвери совсем дауны что-ли?>

← →
N170 (2004-08-20 12:08) [7]

Иногда...

← →
WondeRu © (2004-08-20 12:09) [8]

Игорь Шевченко © (20.08.04 11:57) [4]
Real Programmers don"t write specs.
Users should be grateful for whatever they get:
They are lucky to get any programs at all.

Я понимаю, что в каком-нить тетрисе хелп не нужен - все в картинках и понятно! НОООО... поробуйте интуитивно разобраться с прогой, которая работает с железякой, имеющей кучу параметров?

>Правильно, лучше сразу в корзину.

а Вы так делаете? )))

← →
Goffman © (2004-08-20 12:13) [9]

> Real Programmers don"t write specs.
> Users should be grateful for whatever they get:
> They are lucky to get any programs at all.

Если мои познания в английском удовлетворительны, то данное высказывание полно сарказма

Писать хелп - занятие достаточно утомительное, но самое обидное то, что и бесполезное. Его все равно никто не читает.
Точно так же, как настоящий юзер никогда не читает книг по Windows, Word, Excel и тд. Зачем, если всегда можно попросить подойти знающего человека:)

← →
WondeRu © (2004-08-20 12:13) [10]

по коментариям пишет документацию при компиляции

это есть в Model Maker, он пишет спецификацию на классы и интерфейсы, а не документацию для end user"ов!

← →
reticon © (2004-08-20 12:14) [11]

>> НОООО... поробуйте интуитивно разобраться с прогой, которая работает с железякой, имеющей кучу параметров

Ну, напрмер, АТОЛовский драйвер чекового принтера "Триумф" или "Штрих"... хотя здесь обычному юзеру не надо ничего трогать, это дело администратора

← →
DeadMeat © (2004-08-20 12:15) [12]

Я сам не люблю это дело...
Щас на работе заставлют писать описание, да и ещё не к своей проге (!!). Чего то написал, дык шеф говорит, что в начале надо написать: "Запустите программу ******". Я ему говорю, что если так писать, то начинать надо со слов "Включите компьютер, нажав на самую большую кнопочку на коробочке, которая стоит у вас под столом..."

---
...Death Is Only The Begining...

← →
Aleksey Pavlov © (2004-08-20 12:16) [13]

>>reticon © (20.08.04 12:06) [6]:

Как правило - да =(
К сожалению.
ПРосто мы привыкли общаться с себеподобными. Я был шокирован, когда столкнулся с рядовым пользователем...

Но help писать надо. Хотя у нас для пользователей help"ы пишут специальые люди, с устойчивой психикой =) А всякие Admins Guid"ы, по конфигураторам сервера, которые для технарей предназначены, пишим мы - те, кто эти конфиги и сервера пишет =)
Т.к. админам не надо объяснять, что такое H323 Gate, NAT, PAT и т.д. =)

← →
reticon © (2004-08-20 12:16) [14]

"Запустите программу ******"

это хэлп для шефа....

← →
Игорь Шевченко © (2004-08-20 12:18) [15]

WondeRu © (20.08.04 12:09) [8]

> поробуйте интуитивно разобраться с прогой, которая работает
> с железякой, имеющей кучу параметров?

Смотря как разработан интерфейс программы. Если разработан грамотно, то при знании железки, разобраться интуитивно не составляет труда.

> >Правильно, лучше сразу в корзину.
>
> а Вы так делаете? )))

Нет, я пишу программы, к которым написание help"а трудности не представляет.

← →
Игорь Шевченко © (2004-08-20 12:19) [16]

Aleksey Pavlov © (20.08.04 12:16) [13

> ПРосто мы привыкли общаться с себеподобными. Я был шокирован,
> когда столкнулся с рядовым пользователем...

Учись у MS - они сталкиваются с рядовыми пользователями и их программами пользуются во всем мире.

← →
DeadMeat © (2004-08-20 12:20) [17]

> [14] reticon © (20.08.04 12:16)

По его словам, хелп нужен для того, чтобы он смог посадить любого лоборанта за эту прогу, и чтобы он сделал то, что от него требуют даже, если он ее видит в первый раз... Я ему говорю, что дауна начить будет тяжело, а он говорит, что надо...
Я конечно понимаю, что когда работаешь есть всего два правила:
1) Шеф всегда прав
2) Если шеф не прав, то смотри правило 1.

Но все же... Есть же ещё и способность немного соображать...

---
...Death Is Only The Begining...

← →
ИМХО © (2004-08-20 12:20) [18]

есть кодеры, есть постановщики задач, есть технические писатели... а у нас ты - всё в одном лице!

← →
Aleksey Pavlov © (2004-08-20 12:25) [19]

>>Игорь Шевченко © (20.08.04 12:19) [16]:

=))))
"и Вы мне будете рассказывать" =)
Я помимо всего прочего, ещё за разработку GUI отвечаю =) и книжечка "дизайн пользовательского интерфейса" для меня была "обязятельна к прочтению" =)))

← →
Sandman25 © (2004-08-20 12:29) [20]

[15] Игорь Шевченко © (20.08.04 12:18)

Нет, я пишу программы, к которым написание help"а трудности не представляет.

Неужели всего с одной кнопкой?

PS. Извините за шутку, не смог удержаться :)
От нас требуют полную документацию (User Guide, Administrator Guide), причем еще и в соответствии с внутренними стандартами на оформление и содержание.

← →
Гарри Поттер © (2004-08-20 12:30) [21]

Если написал программу для людей, так объяснить им как ей пользоваться вроде не трудно.

>Ненавижу писать хелп на свои проги,...

имхо, понты.

← →
Игорь Шевченко © (2004-08-20 12:34) [22]

> Неужели всего с одной кнопкой?

Иногда и без нее :)

← →
Игорь Шевченко © (2004-08-20 12:35) [23]

Aleksey Pavlov © (20.08.04 12:25) [19]

> "и Вы мне будете рассказывать" =)
> Я помимо всего прочего, ещё за разработку GUI отвечаю =)
> и книжечка "дизайн пользовательского интерфейса" для меня
> была "обязятельна к прочтению" =)))

Леша, вот ответь на такой вопрос - почему к игрушкам help"ов чаще всего не пишут ? Вроде, там кнопочек много бывает всяких...
Сдается мне, потому, что там интерфейс интуитивный, а уж какие ими (игрушками) пользователи пользуются...

← →
Sandman25 © (2004-08-20 12:36) [24]

>Иногда и без нее :)

Обычно такими "программами" занимаются AVP и DrWeb :)

← →
Sandman25 © (2004-08-20 12:37) [25]

[23] Игорь Шевченко © (20.08.04 12:35)

ИМХО help не пишут, потому что не успевают. И так релизы позже обещанного выходят, геймеры нервничают.

← →
Игорь Шевченко © (2004-08-20 12:38) [26]

Sandman25 © (20.08.04 12:36) [24]

> Обычно такими "программами" занимаются AVP и DrWeb

Открой список процессов на своей машине, будешь приятно удивлен обилием программ "совсем без кнопочек". И "AVP и DrWeb" почему-то ими не занимаются. Странно, правда ?

← →
Sandman25 © (2004-08-20 12:42) [27]

[26] Игорь Шевченко © (20.08.04 12:38)

Не ожидал подобной реакции. Учту, что слово "вирус" запрещено.

← →
mrcat © (2004-08-20 12:42) [28]

>WondeRu
Софта с нормальным хелпом, imho, очень мало; а это не выгодно отличает на фоне прекрасно написанного продукта (возьми, к примеру TheBAT!)

← →
Sandman25 © (2004-08-20 12:43) [29]

Все серьезные программы имеют описания. И чем серьезнее программа, тем оно толще.

← →
Игорь Шевченко © (2004-08-20 12:48) [30]

> Софта с нормальным хелпом, imho, очень мало

Весь софт от MS

Delphi :)))

← →
Aleksey Pavlov © (2004-08-20 12:52) [31]

>>Игорь Шевченко © (20.08.04 12:35) [23]:

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

← →
Суслик © (2004-08-20 12:54) [32]

> чтобы пользователь вообще не задумывался (или тратил на это минимальное кол-во времени)

они всегда именно так и делают.

← →
Vovchik_A © (2004-08-20 12:54) [33]

2Игорь Шевченко © (20.08.04 12:48) [30]
Я продолжу список

ASA :)

← →
Aleksey Pavlov © (2004-08-20 12:56) [34]

>>Суслик © (20.08.04 12:54) [32]:

Если при этом они достигают желаемого результата, то значит интерфейс разработан отлично! =)

← →
Rouse_ © (2004-08-20 13:02) [35]

Эх блин, ну вот напомнил, у меняж хелп не дописан, думал буду балдеть сегодня ... :)

← →
КаПиБаРа © (2004-08-20 13:05) [36]

Иногда в хелпе такого понапишут :)
http://delphimaster.net/view/14-1092645916/

← →
Думкин © (2004-08-20 13:09) [37]

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

← →
Vovchik_A © (2004-08-20 13:11) [38]

2КаПиБаРа © (20.08.04 13:05) [36]

Это не в хелпе. Это в ДНК. Руки таким программистам отрывать. Вместе с гойловой.

← →
Vlad Oshin © (2004-08-20 13:16) [39]

а вот ПЕРЕПИСЫВАТЬ хелпы...
Мы - не софтостроительная шарага
и какой черт меня дернул один раз написать утилитку - теперь приходится править и переписывать хелп

← →
Игорь Шевченко © (2004-08-20 13:17) [40]

Aleksey Pavlov © (20.08.04 12:52) [31]

> Но игрры - это одно, у них у всех интерфейс однотипный и
> содержит в себе не так много параметров

LOL

> А что ты скажешь о конфигураторе сервера, для тонкой настройки
> которого необходимо задать больше сотни параметров?

Открой в MS Word окно "Сервис|Параметры". Посчитай.

Что я скажу о конфигураторе - или выкинуть или сгруппировать параметры в обозримое количество групп. Если не группируются - выкинуть.

> При этом некоторые из этих параметров по определению не
> могут быть интуйтивно понятны.

Выкинуть и не морочить пользователю голову.

← →
WondeRu © (2004-08-20 13:24) [41]

>Если написал программу для людей, так объяснить им как ей пользоваться вроде не трудно.

а если их несколько сотен перевалило! Если сам будешь объяснять, то превратишься из разработчика в службу поддержки!

>Все серьезные программы имеют описания. И чем серьезнее программа, тем оно толще.

у нас ужо за тыщу страниц А4 перевалило

← →
Vovchik_A © (2004-08-20 13:26) [42]

2WondeRu © (20.08.04 13:24) [41]
Тогда, брат, извини... Логику менять надо.

← →
ShaggyDoc (2004-08-20 13:27) [43]

Наличие справки, документации, инсталлятора - главное отличие программного продукта от программы.

Наши гениальные программисты, занимающиеся написанием прог, считают написание help необязательным - как же не понять их гениальные творения? Лучше в форуме потрепаться. Да и зарплата, хоть небольшая, обычно и так капает.

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

Другие же тупые буржуйские чайники читают Help. Наши не читают потому, что он или английский, или "наш". То есть никакой. Серьезный русскоязычный Help к серьезным программам пользователями перечитывается многократно и внимательно. А программисты действительно, не читают. Зачем, когда он сам все знает по любому предмету, с которым никогда дел не имел?

Игорь Шевченко © (20.08.04 12:38) [26]

> Sandman25 © (20.08.04 12:36) [24]
> > Обычно такими "программами" занимаются AVP и DrWeb
> Открой список процессов на своей машине, будешь приятно
> удивлен обилием программ "совсем без кнопочек". И "AVP и
> DrWeb" почему-то ими не занимаются. Странно, правда ?

Чем вирус для винды отличается от вируса для линукс?
Вирус для винды запускается и распростространяется сам, а вирус для линукса поставляется в виде исходников с мануалом и howto :)

> Леша, вот ответь на такой вопрос - почему к игрушкам help"ов
> чаще всего не пишут ?

Таки пишут.
Огромные печатные книги.

Разумеется, не для "тетриса".

> [43] ShaggyDoc (20.08.04 13:27)

То что вы описали - должны делать не программисты. У нас это делали и делают совсем другие люди. Хорошее руководство пользователя должно писаться отнюдь не программистами. И оно читается, причем в основном на бумажных носителях и тупыми нашими прогерами тоже.
Но глубокая вчитка в интерфейсные хелпы - встречается редко. В основном информация черпается из книг или опыта.
В одной конторе писали программы - к каждой хелп, основательный. Но я дико сомневаюсь, что он хоть кому-нибудь понадобился.
Кто-нибудь читал хелп по WinAmp, ACDsee, Total Commander. Конечно это не уровень программ с 1000 страничными хелпами. Но все-таки яйца от желтков надо отделять.

> Кто-нибудь читал хелп по WinAmp, ACDsee, Total Commander

Я читал help к Total Commander :)

DiamondShark © (20.08.04 13:41) [45]

> Таки пишут.
> Огромные печатные книги.

таки это наверное, не help"ом называется :)

> [46] Думкин © (20.08.04 13:41)

Это не означает что хелпы писать не надо. Документация быть должна. Но и готовить ее должны по хорошему другие люди.

> Игорь Шевченко © (20.08.04 12:48) [30]
>
> > Софта с нормальным хелпом, imho, очень мало
>
>
> Весь софт от MS
>
> Delphi :)))

Это в Delphi-то нормальный хелп?!!!

Интерфейс, конечно, неплохо описан, но язык и VCL... Раньше я думал, что хелп в Delphi написан хорошо. Но потом почитал MSDN...

А вообще, есть две вещи, которые, в принципе, могут подразумеваться под хелпом: описание предметной области и описание интерфейса. ИМХО, интерфейс должен быть таким, чтобы тот, кто знает предметную область, мог работать с ним без описаний. Соответственно, и справка по интерфейсу при этом не нужна. А вот саму предметную область надо бы описать. Например, если программа для работы с железкой, то неплохо бы описать, какие параметры железки для чего нужны.

> таки это наверное, не help"ом называется :)

А, ну да. Юзер мануалом.

> Интерфейс, конечно, неплохо описан, но язык и VCL... Раньше
> я думал, что хелп в Delphi написан хорошо. Но потом почитал
> MSDN...

А при чём тут МСДН?

а мне вот нравится описание object pascal reference в дельфовом хелпе

Григорьев Антон © (20.08.04 13:48) [50]

> Это в Delphi-то нормальный хелп?!!!

Ага.

> Раньше я думал, что хелп в Delphi написан хорошо. Но потом
> почитал MSDN...

MSDN тоже неплох, но я не вижу такой уж видимой разницы.

Григорьев Антон © (20.08.04 13:48) [50]
Например, если программа для работы с железкой, то неплохо бы описать, какие параметры железки для чего нужны.

это знать не к чему! инсталляторы меня съедят, если я им еще кучу инфы ненужной подкину!

> Например, если программа для работы с железкой

а если это шифратор?

2 ShaggyDoc
Хорошо сказано.

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

← →
ShaggyDoc (2004-08-20 14:02) [58]

> Думкин © (20.08.04 13:41) [46]

> То что вы описали - должны делать не программисты. У нас это делали и делают совсем другие люди. Хорошее руководство пользователя должно писаться отнюдь не программистами.

Разумеется, это так. В нормальных фирмах так и делается. Они есть (примеры и в этой ветке), но у нас их меньше, чем "обычных" программистов. Которые должны делать все (если уж работаешь не у Билла), а не скулить "я не люблю манную кашу". Или менять работу, фирму (можно на Microsoft).

> [58] ShaggyDoc (20.08.04 14:02)

Разумеется. Вот к той, что делаю сейчас и описание делаю сам.
А скулить вообще никогда не надо - не нравится - меняй или меняйся. :)

Думкин © (20.08.04 14:06) [59]
А скулить вообще никогда не надо

ладно не буду :-))) по ходу написания хелпа пришлось даже править названия некоторых контролов! ;-) и хинты везде, где только бабахать!)))

Ненавижу писать хелп на свои проги,... :-((( Найти похожие ветки