Как показать себя с лучшей стороны?
- Войдите на сайт для отправки комментариев
Для начала хочу описать мою ситуацию. Я начинающий техпис. У меня гуманитарное образование. В конторе, где я прошел испытательный срок только начинает формироваться отдел, который будет заниматься технической поддержкой и технической документацией. Вообщем получил первое задание - написать руководство пользователя для проги. Конкретных требований к руководству не имею, только "должен быть удобным, понятным и фсё в таком духе". В наличии имею документацию тестировщиков, дизайн документы, требования к продукту, а также возможность непосредственного общения с разработчиками (которые как понятно люди занятые).
Так вот, плз поделитесь опытом!!! Как должно быть на самом деле или как работает техпис? Техпис имеет четкие требования, стандарты и от этого отталкивается? А что делать в моем случае, как проявить себя, не имея опыта? Я естественно опираюсь на подобные мануалы похожих продуктов, составляю структуру документа, исходя из логики прочтения. Просто немножко бесит, что не знаешь чего ждать после первой проверки начальства. А с другой стороны, если нет четких требований - какие тогда обязательства? Вообщем посоветуйте что-нить! и как оно обычно фсё происходит?
Если же Вы приходите с чистым листом, но массой предложений Вас сначала послушают (в лучшем случае), а потом сделают определенные выводы (какие? - Вы уже услышали). С руководителями надо разговаривать на конкретную тему и на конкретные вопросы.
sha, брависсимо! Что значит военная закалка 
К руководству нет смысла соваться неподготовленным, без письменного перечня наболевших вопросов в виде служебной записки, без готового документа - приказа, аналитической записки и т.д. Отцы-командиры этого не любят. Можно здорово подпортить собственный имидж.
для 2lik
Спокойствие, только спокойствие (по моему Карлсон) и ещё
...надо быть спокойным и упрямым... (А. Пахмутова "Надежда")
Отработайте структру док-та. Заполните те разделы по которым есть информация, по тем разделам (темам и вопросам) по которым нет ничего поставьте три (можете больше ???) вопросов (таким образом я обычно отмечаю проблемные места, для того что бы по поиску их быстро найти). и только с таким "скелетом" НАДО говорить с начальством. Если же Вы приходите с чистым листом, но массой предложений Вас сначала послушают (в лучшем случае), а потом сделают определенные выводы (какие? - Вы уже услышали). С руководителями надо разговаривать на конкретную тему и на конкретные вопросы.
одно из определений рук-ва (правда с купюрами): Рук-во представляет собой документ, содержащий техническое описание и инструкцию по эксплуатации, куда включаются все сведения, необходимые для правильной экспл-ции.
согласен, Surgeon! Как я понял, начальство само не знает чего хочет. Хотят из говна получить конфетку. Просто проще ведь фсего усомниться в работе неопытного молодого техписа, чем всерьез задуматься о собственном менеджменте. И вообще я первый кто занялся этим. И мне со своей стороны обидно, что в такой ситуации очень трудно себя проявить. Ну кто меня будет слушать... пойду выпью йаду... гы, шутка! пойду думать как произвести революцию в процессе написания документации в конторе ! фух, выговорился...
Руководство заняло традиционную позицию. А что, по мнению руководства, представляет собой офигенный юзер гайд? Не спрашивали? Каким руководство видит такой юзер гайд? Может, образец какой-нибудь покажет, а Вы по этому образцу и сделаете?
Вынудите отцов-командиров дать Вам конкретный образец. Дадут - потом претензий к Вам предъявить не смогут, если докажете, что все сделано по их образцу. Не дадут - требуйте разработки СтО на офигенные юзер гайды, чтобы то же руководство могло объективно оценивать Вашу деятельность.
вопсчем как я и предполагал - так и получилось. Моё начальство конечно же сделало офигительный вывод! Конечно же отсутствие документации ето плохо, а что же делать? Оказывается фсё очень просто! Нужен фсего нафсего опытный техпис, а не такой, как я (опыта у меня нет, и нигде етому у нас не учат). Так вот опытный техпис прийдет и напишет офигенный юзер гайд! Блин, объясните мне люди добрые - откуда пусть даже опытный техпис будет знать как и что надо делать, чтобы работать с софтом???? Тем более когда софт сделан на 80%... млин, объясните как построена работа техписа???? у нас есть тока старая документация, которая в процессе разработки не обновлялась... блин, или я реально слишком зеленый, или с опытом развивается шестое чуфство...
да-да, это именно то, что мне было нужно. почему-то я обошла эту статью своим вниманием. благодарю!
наша программа предназначена для людей, которые скорее админы, чем простые юзеры - следовательно, писать что руководство предназначено для выработки у такого пользователя практических навыков работы с программой - бессмысленно, да?
Конечно. Админ сам разберется. Админу можно просто написать - настрой DHCP-сервер, и он настроит. Не спрашивая, как это сделать с помощью программы. См. http://authorit.ru/?c=8&b=6
Это руководство, а не просто описание. А руководство, по-определению, предназначено также:
- для выработки у пользователя практических навыков работы с программой;
- для выработки у пользователя четких ассоциаций предметной области с элементами интерфейса.
Стоит добавить, что руководство предназначено для определенного уровня пользователя - для дурака, для админа и т.д.
вот смотрите: наша программа предназначена для людей, которые скорее админы, чем простые юзеры - следовательно, писать что руководство предназначено для выработки у такого пользователя практических навыков работы с программой - бессмысленно, да?
а как лучше оговорить тот факт, что она предназначена для пользователя определенной категории?
вобщем, ужас 
В том то и дело: нет вопросов - нет ответов, дискуссий, обсуждений Нет самоподдерживающегося процесса. Поэтому вопросы в форуме задавать надо. Оптимально - в профильную тему, если такая есть в форуме.
Surgeon, спасибо! 
да спросить, как Вы понимаете, всегда есть, что - особенно в моей ситуации другое дело, что я все это пыталась уяснить для себя, подглядывая в дискуссии, а не задавая свои вопросы отдельным постом
впрочем, вопросов уже накопилась критическая масса, похоже :/
Ginger, вот видите - есть, что спросить
вот, к примеру, раздел под названием "назначение руководства". достаточно ли будет написать там "Настоящее руководство предназначено для ознакомления пользователя с техническими характеристиками и функциональными возможностями программы NNN" - или нужно/требуется/желательно написать еще что-либо? что?
Это руководство, а не просто описание. А руководство, по-определению, предназначено также:
- для выработки у пользователя практических навыков работы с программой;
- для выработки у пользователя четких ассоциаций предметной области с элементами интерфейса.
Стоит добавить, что руководство предназначено для определенного уровня пользователя - для дурака, для админа и т.д.
или, например, раздел "ограничения области применения программы". не придумала ничего более умного, чем написать: "Область применения программы NNN ограничена заложенными в нее функциями, поэтому программа не может быть использована для достижения каких-либо иных целей и/или решения каких-либо иных задач." или тут надо прописать, что стирать, играть на гитаре, вязать, писать письма, etc., etc., etc. софтина не умеет?
Стоит оговорить то, что пользователь явно может попытаться сделать. Например, если программа может открывать файлы всех графических форматов, кроме tif, об этом сказать надо.
оооооооо... да у нас с вами ситуация практически одинаковая: наше руководство - после многократных нареканий на отсутствие у нашего софта грамотной документации - решило взрастить из меня техписа.
за дело я принялась с огромной радостью и энтузиазмом: нашла существующие по этому предмету статьи и ГОСТы, почитала умных людей на форумах и... бодро принялась писать руководство пользователя.
и как-то не выходит у меня... каменный цветок... 
вот, к примеру, раздел под названием "назначение руководства". достаточно ли будет написать там "Настоящее руководство предназначено для ознакомления пользователя с техническими характеристиками и функциональными возможностями программы NNN" - или нужно/требуется/желательно написать еще что-либо? что?
или, например, раздел "ограничения области применения программы". не придумала ничего более умного, чем написать: "Область применения программы NNN ограничена заложенными в нее функциями, поэтому программа не может быть использована для достижения каких-либо иных целей и/или решения каких-либо иных задач." или тут надо прописать, что стирать, играть на гитаре, вязать, писать письма, etc., etc., etc. софтина не умеет?
может быть, многоуважаемые профессионалы техписательства разъяснят мне, что так, а что - не так и дадут пару-тройку бесценных в моей ситуации советов?
заранее спасибо.
во, нашел вроде... спасибо за совет... буду чё-та делать...
Не нашел. Посмотрите здесь - http://authorit.ru/forum/viewtopic.php?p=994 , там есть ГОСТы по качеству ПО, цельнотянутые с буржуйских.
На IEEE, насколько знаю, все платное.
Предложите начальству разработать СтО, который предусматривал бы требования к содержанию и оформлению этих самых юзер гайдов в Вашей компании. Только писать такой СтО самому придется. Зато для себя, любимого
да-да, я читал про "косточки"... вообще официальный сайт ieee.org как я понимаю? и там ети буржуи ещё и за бабки продают стандарты я так понимаю... вообщем я для чего фсё спрашиваю...мне надо письмо начальству написать, чтобы они давали четкие требования для написания Юзер гайдов... и блин опирались на стандарты.. а то я получаюсь самым крайним...
Есть такой IEEE Std 1063-2001 «IEEE Standard for Software User Documentation», пробовал его разобрать по косточкам в статье Как писать руководство пользователя. Полный текст был где-то, но куда-то делся. Щас...
Уважаемый Surgeon! Подскажите где можно посмотреть американские стандарты для написания юзер гайда... вы мне наверно быстрее и точнее ответите, чем гугл... спасибо...
Повнимательнее - для наездов создана отдельная ветка - http://authorit.ru/node/193#comment-2464
Большое спасибо всем за ответы и советы. Невероятно, но стало легче! Правда только психологически. Как сказал мне один тестировщик: "Тебя поимеют, но главное шоб несильно!" Вот такую задачу я себе и ставлю...
sha, дык... Как-никак, почти что одна школа
А это для 2lic, из моей статьи Как писать техническое задание?!
Техническое задание и его назначение
Большому Боссу, непосредственно взаимодействующему с Заказчиком, техническое задание дает возможность избежать участи мастера-умельца (об этом ранее упоминалось неоднократно).Для маааааааленького техписа, работающего на Большого Босса, разработка технического задания есть:
средство заработать себе на «покушать»;
способ показать, что техпис - не тварь дрожащая, а право имеет - способ вырасти в глазах Большого Босса.
Крайнее утверждение - палка о двух концах. Ах, ты умный, умеешь? Так на тебе еще работенки. А жалование поднимем. Когда-нибудь.В любом случае, способность грамотно разработать техническое задание - показатель высокой квалификации разработчика.
Считаем, что первый вопрос (в первом же приближении) закрыт.
содержание наших предыдущих постов практически одинаковое
surgeon: мы не за одним компом сидим?
Не понял Вас, повторите
surgeon: мы не за одним компом сидим?
и вообще что мне не нравится, что я иду в ровень с разработкой т.е. у меня нету окончательной версии продукта,
это Вы еще в "тепличных условиях". у меня ситуция, когда разр-ки отстают, а заказчик требует док-цию. это, как не парадоксадьно, обычная история. Никто Вам не даст готовый продукт, по которому будете спокойно делать свою работу.
Под 2) я понимал, нормативную документацию на основании которой Вы будете делать свою, то есть если Вы останавливаетесь на ГОСТах - это ГОСТы, на которые дал ссылки surgeon
да и вообще я не понимаю какие пределы описания каждого пункта содержания
Это только с опытом приходит. Должно быть не слишком общее, но и не детализоровано. Достаточно чтобы пользователь понял. Как проверить? Дайте своему знакомому почитать...
и вообще что мне не нравится, что я иду в ровень с разработкой т.е. у меня нету окончательной версии продукта, а сроки по ходу одинаковые с девелоперами.
Это типичная ситуация в софтверных компаниях.
Поправьте меня, если так не бывает: как я понимаю у меня должна быть вся документация, касающаяся продукта, причем финальной версии, и продукт должен быть сделан и протестирован, так
Так было один-единственный раз - финальная версия, правда, документации никакой. От программеров.
я бы сначала провел небольшой анализ.
1) кто пользователь продукта (для того что бы определить выдвигает ли он какие требования к офрмлению док-ции на продукт)
2) какая нормативная докум-ция есть в фирме, необходимая для разр-ки док-ции на продукт (это для того что себе четко представлять какое нормативное обеспечение, а то иногда поиск необходимого док-та займет больше времени, чем разработка док-ции )
вот что у меня и происходит сейчас! документация в фирме не финальной версии ! и вообще что мне не нравится, что я иду в ровень с разработкой т.е. у меня нету окончательной версии продукта, а сроки по ходу одинаковые с девелоперами. Поправьте меня, если так не бывает: как я понимаю у меня должна быть вся документация, касающаяся продукта, причем финальной версии, и продукт должен быть сделан и протестирован, так? после этого я начинаю работу?
да и вообще я не понимаю какие пределы описания каждого пункта содержания...
я бы сначала провел небольшой анализ.
1) кто пользователь продукта (для того что бы определить выдвигает ли он какие требования к офрмлению док-ции на продукт)
2) какая нормативная докум-ция есть в фирме, необходимая для разр-ки док-ции на продукт (это для того что себе четко представлять какое нормативное обеспечение, а то иногда поиск необходимого док-та займет больше времени, чем разработка док-ции )
Как должно быть на самом деле или как работает техпис? Техпис имеет четкие требования, стандарты и от этого отталкивается?
Совершенно верно. Руководства на софтину расписаны:
- в ГОСТ 19.503-79 Руководство системного программиста. Требования к содержанию и оформлению - http://www.nist.ru/hr/doc/gost/19503-79.htm
- в ГОСТ 19.504-79 Руководство программиста. Требования к содержанию и оформлению - http://www.nist.ru/hr/doc/gost/19504-79.htm
- в ГОСТ 19.505-79 Руководство оператора. Требования к содержанию и оформлению - http://www.nist.ru/hr/doc/gost/19505-79.htm
Может быть, имеет смысл почитать статью Как писать руководство пользователя - http://author-it.ru/?c=8&b=4 , там есть еще и вторая часть, а также посмотреть материалы раздела ГОСТ 19 - http://author-it.ru/?c=2
Будут вопросы - пишите. Что бы Вам ни "вешали на уши" техписы с философтовского форума - знание стандартов есть верный признак профессионализма.
- Войдите на сайт для отправки комментариев
Не, один то раз можно - задать лукавый вопрос: "Чего изволите?" - сойдет и на скорую руку и быстро-быстро конспектировать высочайшие велеречения. Но дальше уже все по взрослому, как доктор
ниже прописал.
Оченно хорошо, когда над общаемым бугром есть самый большой бугор - тогда нуна изладить приказ, по которому общаемый бугор обязан сделать до фига всего и еще и за все ответит.
Но тут в мотивировке должна быть железобетонная логика, а не то... как указывал sha, сделают определенные выводы... 