19.04.2012
Документация в системе ЛокОФФИС
Readme: разумное, доброе, вечное.Информационная поддержка программного комплекса ЛокОФФИС
или зачем тратить время на разработку описаний к программам.
или зачем тратить время на разработку описаний к программам.
В. Гаврилов, к.т.н. Журнал "Бухгалтер и компьютер" №11. 2001.
Рубрика "Знакомимся с программой".
Процесс освоения и внедрения любого серьезного программного продукта включает в себя два основных этапа: на первом пользователю предстоит познакомиться с программой и научиться выполнять с ее помощью самые необходимые и простые операции, а на втором - более глубоко изучить все те возможности, которые программа ему предоставляет, и использовать их для решения своих задач.
Основная цель информационной поддержки любой программы, по моему мнению, состоит в создании разработчиками программы некой совокупности пособий, дающих пользователю возможность на первом этапе в короткие сроки и с минимальными затруднениями освоить и внедрить новую для себя программу. А на втором этапе эти пособия должны помочь людям, работающим с программой, глубоко изучить ее и в полной мере использовать все функциональные и аналитические возможности, необходимые настройки и удобства, чтобы не пользоваться "микроскопом вместо молотка, хотя он тоже тяжелый".
Наш программный комплекс изначально был предназначен для автоматизации учета в торговой или посреднической фирме. За последнее десятилетие эта сфера человеческой деятельности в нашей стране получила значительное развитие, как вширь, так и вглубь. А в силу ряда социальных и экономических причин в значительной мере пополнилась людьми, которые по своему образованию и характеру предыдущей трудовой деятельности были далеки от торговли. Хорошо, если они имели хотя бы какой-либо опыт использования персонального компьютера (ПК). Поэтому еще при первых "выходах в свет" программы системы ЛокОФФИС были рассчитаны на пользователей, обладающих минимумом знаний. Мы старались обеспечивать их предельно понятными и доступными интерфейсами, снабженными пояснениями и подсказками, а действия пользователя при работе с программой - сделать для него очевидными.
Однако практика показывает, что есть и другая категория пользователей. Так называемые, "просвещенные". Это люди, имеющие опыт работы с ПК, уже освоившие самостоятельно какие-либо "пакеты" программ, а иногда имеющие опыт программирования. Такие пользователи не привыкли использовать средства информационной поддержки программных пакетов как в силу их отсутствия (ведь не секрет, что часто эти пакеты не являются лицензионными), так и по причине своей, в хорошем смысле, самоуверенности. Такие люди, несомненно, могут освоить наши программы быстрее, не прибегая к помощи разработчиков. Но иногда, пренебрегая нашей информационной поддержкой, в течение долгого времени будут использовать только их самые простые и очевидные приемы работы, не подозревая обо всем спектре функциональных возможностей и удобств, предусмотренных программным комплексом. Учить пользователей методам освоения новых программ дело неблагодарное, особенно в случае их "просвещенности". Своей задачей мы считаем предоставление им всего необходимого для освоения, понимания и внедрения программы.
Необходимо остановиться еще на одном аспекте создания средств информационной поддержки, связанном с различным уровнем подготовки пользователей. Мы стараемся в этом вопросе ориентироваться на самый низкий уровень пользователя. Приняв концепцию простоты и доступности работы с программами, мы вынуждены излагать документацию к ним так, чтобы она была предельно понятна пользователю независимо от уровня его общего и специального образования, что иногда приводит к излишнему "разжевыванию" и повторам в изложении. Тем не менее, мы считаем это оправданным. Пусть лучше "просвещенный" пользователь бегло пробежит или пропустит несколько абзацев руководства, чем менее "просвещенный", да еще и работающий "в глубинке", останется в неведении хотя бы об одной из многих функций программы.
"Близкие" и "удаленные" пользователи
Хотелось бы еще поделиться своими наблюдениями за поведением пользователей в зависимости от их территориальной удаленности от разработчика. Для большинства пользователей, использующих услугу по сопровождению программы, фирма дает возможность удовлетворять возникающие вопросы в режиме "горячей линии" по телефону или электронной почте. Кстати, электронная почта используется все больше и больше. Однако часто слышишь от пользователя и такие слова: "Зачем я буду отыскивать ответы на возникающие вопросы, читая прилагаемые к программе руководства и описания? Для меня гораздо легче снять трубку и получить ответы по телефону". Иногда приходится, просто хочется, напомнить таким пользователям, на какой странице какого документа предельно ясно изложен ответ на интересующий вопрос. Практика показывает, что такая позиция характерна для избалованных надежными и недорогими средствами связи московских пользователей.
Но мы продаем программу по всей России и часто наблюдаем, что чем дальше от Москвы или Санкт-Петербурга (в этом городе фирма имеет свое представительство) живет и работает пользователь, тем в большей мере самостоятельно он осваивает программу. Хотелось бы верить, что в этом ему помогает та информационная поддержка, которую он получает вместе с нашими программами.
Версионная поддержка
Наш программный комплекс динамично развивается с учетом не только изменений законодательства, но и постоянно обогащающейся практики наших пользователей, появления новых форм документов и справок, а также расширения функциональных возможностей программ. Это приводит к периодическим обновлениям версий программы. Поэтому актуальной является проблема отслеживания в различных формах информационной поддержки изменений, происходящих в программах от версии к версии. Мы стоим на позиции, в соответствии с которой пользователь должен быть обеспечен руководствами и описаниями, максимально соответствующими той версии программы, которую он от нас получает. Таким образом, для себя мы выделили несколько требований, которым должны отвечать предоставляемые нами средства информационной поддержки программ:
- Независимо от формы информационной поддержки они должны быть максимально доступны и просты для понимания независимо от уровня подготовки пользователя;
- Они должны охватывать и снимать весь комплекс проблем, возникающих у пользователя не только на этапе ознакомления с программой, но и в дальнейшем, при более глубоком ее изучении и внедрении;
- Средства должны оперативно отражать все изменения, происходящие в программах по мере их развития и совершенствования;
- Мы стараемся, чтобы нашими средствами информационной поддержки в электронной форме мог пользоваться любой пользователь, независимо от версий установленного на его ПК общего программного обеспечения.
- Независимо от формы информационной поддержки они должны быть максимально доступны и просты для понимания независимо от уровня подготовки пользователя;
- Они должны охватывать и снимать весь комплекс проблем, возникающих у пользователя не только на этапе ознакомления с программой, но и в дальнейшем, при более глубоком ее изучении и внедрении;
- Средства должны оперативно отражать все изменения, происходящие в программах по мере их развития и совершенствования;
- Мы стараемся, чтобы нашими средствами информационной поддержки в электронной форме мог пользоваться любой пользователь, независимо от версий установленного на его ПК общего программного обеспечения.
Распределенная система подсказок и описаний
Какие же формы информационной поддержки предусмотрены для нашего программного комплекса?
1. Начну с самого простого. В каждом режиме работы программы, не выходя из него, пользователь с помощью функциональной клавиши F1 (или правой кнопки "мыши") может получить контекстную подсказку, из которой узнает: для чего предназначен данный режим, как и с помощью каких средств управления им можно пользоваться. Этот HELP имеет достаточно ограниченные размеры, но, тем не менее, содержит необходимый минимум сведений, требующихся для корректной работы с программой в интересующем режиме.
2. Во всех основных режимах работы программы при формировании первичных учетных документов (как правило, при работе с их спецификациями) с помощью правой кнопки "мыши" или клавиши F6 на экран вызывается функционально активный перечень действий пользователя. Выбор конкретного пункта этого перечня позволяет непосредственно перейти к выполнению нужной операции. Те пункты, которые не могут быть доступны в данной ситуации (в силу особенностей документа или его текущего состояния) в меню затеняются.
3. Кроме того, в электронном виде вместе с программой поставляются краткие рекомендации по инсталляции программы и перечень нововведений и доработок, произведенных от версии к версии.
4. Документация на программу в печатном виде. Она состоит из ряда книг, дающих возможность не только получить начальные сведения о составе и возможностях программ, но подробное описание всех настроек и имеющихся режимов работы каждого из модулей программы. Печатная форма информационной поддержки включает в себя два типа документов:
- первый - руководства пользователя по работе с основными подсистемами (например, с подсистемой ТОВАР),
- второй - подробные описания модулей, составляющих ту или иную подсистему, а также дополнительных опций комплекса.
1. Начну с самого простого. В каждом режиме работы программы, не выходя из него, пользователь с помощью функциональной клавиши F1 (или правой кнопки "мыши") может получить контекстную подсказку, из которой узнает: для чего предназначен данный режим, как и с помощью каких средств управления им можно пользоваться. Этот HELP имеет достаточно ограниченные размеры, но, тем не менее, содержит необходимый минимум сведений, требующихся для корректной работы с программой в интересующем режиме.
2. Во всех основных режимах работы программы при формировании первичных учетных документов (как правило, при работе с их спецификациями) с помощью правой кнопки "мыши" или клавиши F6 на экран вызывается функционально активный перечень действий пользователя. Выбор конкретного пункта этого перечня позволяет непосредственно перейти к выполнению нужной операции. Те пункты, которые не могут быть доступны в данной ситуации (в силу особенностей документа или его текущего состояния) в меню затеняются.
3. Кроме того, в электронном виде вместе с программой поставляются краткие рекомендации по инсталляции программы и перечень нововведений и доработок, произведенных от версии к версии.
4. Документация на программу в печатном виде. Она состоит из ряда книг, дающих возможность не только получить начальные сведения о составе и возможностях программ, но подробное описание всех настроек и имеющихся режимов работы каждого из модулей программы. Печатная форма информационной поддержки включает в себя два типа документов:
- первый - руководства пользователя по работе с основными подсистемами (например, с подсистемой ТОВАР),
- второй - подробные описания модулей, составляющих ту или иную подсистему, а также дополнительных опций комплекса.
Все виды печатных документов детально иллюстрированы примерами экранов, которые пользователь может реально видеть на своем дисплее, находясь в том или ином режиме работы программы.
Руководства пользователя
В руководствах мы шли как бы от основных задач, решаемых пользователем, особенно на начальных этапах освоения и внедрения программы. Вначале руководство пользователя так и называлось "В помощь начинающему". Впоследствии оно "разрослось" до более солидного документа, в котором мы рассказываем не только о составе и начале работы с программой (например, начальные действия пользователя, порядок ввода и заполнения первичных документов, работу с каталогами и т.п.). Кроме того, с помощью такого руководства мы пытаемся помочь пользователям освоить наиболее важные приемы работы с программой (работу с ценами, скидками, упаковками, печатными формами, общересурсными складами и т.д.). Несмотря на насыщенность этого документа, мы стараемся сделать его доступным и небольшим по объему, таким, чтобы его вид не вызывал "испуга" и отторжения у пользователя.
Руководства наиболее оперативно отражают новые возможности программ и должны в максимальной мере соответствовать поставляемой версии комплекса.
Описание модулей и подсистем
Другой тип печатной формы информационной поддержки - описания модулей и подсистем. Эти документы строятся от задач, решаемых тем или иным модулем или подсистемой, и содержат описания всех имеющихся режимов, порядка работы в них, всех настроек, которые могут осуществляться, а в некоторых случаях - рекомендации по порядку использования модуля или подсистемы. Эти документы также обильно "сдобрены" иллюстрациями в виде экранных форм, примерами справок и печатных форм документов. Обычно описания модулей брошюруются нами по подсистемам. В них мы тоже стараемся оперативно и своевременно отражать изменения, вносимые в программы.
По нашему мнению, комплект из этих двух типов печатных документов (Руководства пользователя и Описания модулей) при наличии желания пользователя (что является определяющим для результата) дает ему возможность не только детально познакомиться с программами и внедрить их, но и освоить все имеющиеся функциональные возможности и приемы работы с используемыми программами.
Электронные версии документации
Ну и наконец, хотелось бы рассказать о новой для нас форме информационной поддержки программы, которую мы внедрили в интересах созданного продукта ЛокОФФИС - Лимитед.
Она представляет собой электронную версию Руководства пользователя по подсистемам ТОВАР и БУХГАЛТЕРИЯ, которыми мы снабжаем поставляемые программы. Для того, чтобы у пользователя не возникали проблемы по ее установке и использованию, мы использовали пакет Adobe Acrobat и получили документы в формате pdf. Кроме того, инсталляционный диск с программами позволяет пользователю вместе с комплексом ЛокОФФИС при желании установить свободно распространяемую программу Acrobat Reader (если у пользователя она отсутствует), с помощью которой электронные формы документов могут быть прочитаны, а при необходимости и отпечатаны.
Доступ к этим документам осуществляется непосредственно из используемой программы ЛокОФФИС. Каждый из документов снабжен интерактивным оглавлением, позволяющим обращаться к тому разделу документа, который в данный момент необходим. С учетом наличия возможности многооконной работы пользователь может одновременно видеть на дисплее и непосредственно программу, и нужный раздел руководства по работе с ней. Хочется надеяться, что эта форма помощи пользователю найдет у него признание и подогреет интерес к издаваемым нами руководствам и описаниям программ.
Нам хотелось поделиться с читателями своим опытом по созданию и использованию различных форм информационной поддержки программного комплекса, а также проблемами, с которыми мы при этом сталкиваемся. Наряду с совершенствованием и расширением функциональных возможностей самих программ, мы и в дальнейшем будем уделять пристальное внимание разработке новых и улучшению уже имеющихся форм их информационной поддержки. Хотелось бы также узнать об опыте наших коллег в этой области. Внедрение крупных программных систем силами пользователя (т.е. без контракта на внедрение с разработчиком или его представителем) представляет одну из насущных задач для малого и среднего бизнеса.
