Существует такое понятие как «интуитивно понятный интерфейс». Оно означает, что все внутри программы, модуля, расширения и прочих технических решений сделано таким образом, что любой человек, впервые столкнувшийся с интерфейсом, сможет без инструкций самостоятельно и быстро научиться использовать все функции. Однако, на практике такого практически не бывает. Всегда найдутся части, которые либо требуют пояснений, либо непонятны, либо зависят от уровня знаний человека.
Поэтому, практически каждый, кто когда-либо создавал программы, писал модули и прочее, рано или поздно сталкивается с тем, что необходимо писать инструкции к своим произведениям искусства. Но, далеко не у каждого есть достаточный опыт сопровождения каких-либо продуктов для того, чтобы итоговый документ был понятен и удобен для использования. Поэтому, в рамках данной статьи я расскажу вам ряд советов на тему «написание инструкций для программ и модулей». Сразу оговорюсь, что данный материал в первую очередь направлен для новичков.
Как написать инструкцию
Итак, одним ранним вечером, вы посмотрели на свое творчество и поняли, что нашпиговывать его подсказками дело весьма интересное, но после определенного периода бесполезное и даже деструктивное, так как интерфейс попросту начинает ломиться от таких излишеств. Поэтому, вы открыли офисный пакет и создали документ под названием «инструкция». Но, вот что делать дальше совершенно не представляете. Так что посмотрим на весь процесс по шагам.
1. Разбейте документ на подразделы. Одной из самых больших ошибок новичков является то, что они начинают сразу составлять текст, красочно описывая достоинства своей программы. Конечно, если вся инструкция представляет собой только один абзац, то можно сразу его написать, но так обычно не бывает. Проблема такого подхода заключается в том, что если вы сразу не определите подразделы в документе, то со временем такая инструкция превратится в «неописуемый фарш», где найти необходимую информацию просто нереально. И такого рода инструкции не редкость.
Поэтому, прежде всего, определите несколько подразделов и выделите их. Обычно, начинают с таких вещей, как «Описание», «Назначение», «Установка», «Использование», «Лицензия», «История версий» и прочие важные вещи для вашего продукта. Даже если на момент написания в каждом разделе будет всего по одному небольшому предложению, то потом вы искренне себя поблагодарите за то, что не пошли на поводу у лени. И речь не только о том, что вам самим легче будет понимать куда добавлять информацию, но и о том, пользователям будет легче ориентироваться в инструкции, так как у них есть возможность быстро определить какая часть из всей вашей простыни текста им нужна. И только после этого переходите к написанию текста.
2. Старайтесь придерживаться официального стиля оформления. Еще одной ошибкой является использование вольного стиля при написании инструкций для программ и модулей. Помните, что инструкция это не рекламная брошюра или легкая беседа в чатике.
Как писать инструкции для людей? Работа персонала по инструкциям
И дело тут не только в том, что разноцветные тексты или же сленг неудобно читать, а в том, что документ будут смотреть люди разного стиля мышления. Одни поймут о чем речь, другие не поймут, третьи запутаются в ваших неоднозначных высказываниях, а четвертые и вовсе не станут разбираться в ваших творческих порывах. Поэтому чем более формально будет составлен текст, тем больше людей прочтет ваши инструкции и тем меньше будет появляться тем вроде «как в этой фигне сделать вот это» (несмотря на то, что все это есть в инструкции).
Важно понимать, что формальный текст не означает сухой доклад, от которого хочется повесится в конвульсиях. Например, инструкции легко можно наполнять шутками, но не узкоспециализированными. Суть официального стиля в том, что бы сэкономить время всем — вам, как автору, которому приходится отвечать на однотипные вопросы, и людям, которые будут пытаться разобраться в вашей программном продукте по инструкции. Даже с теми, кто обычно не читает инструкции, станет легче, так как вы всегда сможете сказать «в инструкции все описано доступным языком».
3. Текст должен быть максимально простым. С точки зрения банальной эрудиции каждый локальный индивидуум. Знакомая фраза? Если в тексте встречается много таких конструкций, то такое творение становится невозможно читать. Каждый сможет вспомнить хоть один такой текст в своей жизни, а так же то, сколько он плевался за все время чтения.
Поэтому, при составлении документа, полезно периодически вспоминать такие «шедевры», тогда оценивать свой текст на простоту становится легче.
Если чуть проще и другими словами, то когда вы пишите текст, то фраза «это итак понятно» должна относится только к таким фразам, как «нажмите кнопку», «наведите курсор мышки» и прочее. Все, что по уровню интеллекта находится выше этих фраз, автоматически должно относится к категории «это нужно пояснить».
Примечание: Кроме того, стоит понимать, что каждый сложный фрагмент текста становится отличным поводом написать автору кучу однотипных сообщений.
4. Мелочи, мелочи, мелочи. Если у вас ни разу не возникало желание достать топор из кладовки по той причине, что в инструкции не были описаны «очевидные автору» вещи и вы потратили часы впустую, то вам повезло. Важно понимать, что любая неописанная мелочь легко может превратиться в существенную проблему. Например, если вы не напишите, что порядок установки и конфигурации безумно важен (что не следует просто из того, что в инструкции стоят номера перед каждым пунктом, как в обычном списке), то каждый человек, у которого уже что-либо установлено или настроено, мысленно пожелает вам много интересных приключений в жизни.
Конечно, это не означает, что необходимо создавать энциклопедию из документации, однако все важные моменты и уточнения должны быть описаны, даже если сейчас они вам кажутся «примитивными» и «всем известными».
5. Необходимые условия и обязательные требования. Очень часто этот пункт опускают. И далеко не всегда для тех программ и модулей, где это действительно неважно, так как условия и требования соблюдаются по умолчанию. Важно понимать, что не все разбираются в вашем продукте и используемых технологиях.
Поэтому, когда вы пишите свою инструкцию, постарайтесь задумываться над тем, необходимо ли что-то для запуска ваших продуктов и их отдельных функций. К примеру, необходимо установить фреймворк или же выполнить какие-то дополнительные шаги по настройке.
Существуют и другие важные моменты, однако в большинстве случаев, этих советов вполне достаточно, чтобы составить нормальную инструкцию для программ и модулей, которая будет экономить всем время, нервы и силы.
Источник: ida-freewares.ru
Писать руководство пользователя по шаблону. Удобно? Удобно
Команда, разрабатывающая софт для создания пользовательской документации, делится лайфхаками на тему написания идеальной пользовательской документации для тех, кто далёк от написания руководств к программе.
Для чего мы сами конструируем некоммерческие образцы документации и инструкций для пользователей
Наш проект существует и развивается уже долгое время, практически шестнадцать лет, если быть точнее. За этот срок была сформирована определенная база, где собраны самые актуальные и насущные вопросы, которые возникают перед людьми, создающими справочные элементы к своему проекту.
Ведя диалог с нашими клиентами, мы смогли выделить их потребности и понять основную «боль». Если обобщить, основная проблема заключалась в том, что ни одна программа для создания файл-справок и инструкций не могла выполнить самую нудную, энергозатратную часть проекта — само разрабатывание и оформление этой пользовательской документации
Даже имея осознание того, что файл-справка — неотъемлемый и действительно полезный элемент для пользователя, очень редко возникает мотивация оформить его грамотно и качественно. Еще реже желание возникает, когда в написании пользовательской документации нет опыта или специалистов, которые бы этот опыт имели. Обычно, эта обязанность с легкой руки падает на плечи самих создателей программы, людей, занимающихся тестированием, аналитикой, специалистам поддержки или даже руководителей компании, которые тоже не совсем понимают, как грамотно создать что-то подобное.
Отсюда вытекает еще одна загвоздка. Люди, у которых нет опыта и в принципе понимания, как начать и что туда вносить, просто не знают, как создать качественное руководство для пользователей. В таких случаях большинство следует привычному пути: загуглить определение и найти готовый шаблон.
И с какой-то стороны, это разумно. Мы достаточно часто сталкиваемся с такими запросами, пользователи просят у нас пошаговое руководство или хотя бы костяк готовой инструкции.
Так вышло, что потребности наших клиентов практически на сто процентов входят в нашу экспертную сферу. И мы приняли решение по возможности помочь всем, кто хочет (или вынужден) заниматься созданием файл-справок и инструкций к своему продукту и предоставить возможность получить образцы, которые могут послужить базой и легко быть адаптированными под конкретный запрос.
В связи с этим, мы сами создали готовые образцы и костяки шаблонных проектов в программе. Что входит в нашу базу:
- Руководство пользователя программного обеспечения.
- Руководство пользователя web-сервиса.
- Корпоративная база знаний компании.
В чем удобство создания руководства пользователя по образцу
Вы бережете своё время.
Адаптируя уже созданный образец под свой продукт, вы не тратите время на создание основы с нуля, вам не нужно тратить время, чтобы найти мастер-класс о том, как правильно это сделать. Используя готовый шаблон документации, вы значительно экономите время на создание структуры проекта с нуля и на поиск и изучение информации о том, как это делается.
Вы сосредотачиваете внимание на вашей программе, а не на создании файл-справки
В шаблоне уже есть текстовые и графические вставки, вы можете сами добавлять нужный контент в предложенные места и не продумывать вариант оформления.
Наглядность.
Все образцы и костяки инструкций для пользователя изначально настроенные с динамическими стилями оформления, которые помогут вам быстрее освоиться и разобраться, как можно использовать это для быстрого выполнения своей цели.
Адаптация шаблонов и образцов под ваш проект.
Всё, что находится в шаблонах, можно назвать нашим советом, который был создан на основе многолетнего опыта в данной сфере и выработанной экспертностью. Абсолютно всё в этих шаблонах может быть подвержено адаптации, так как для пользовательской документации нет жестких стандартов, она должна быть выстроена персонально под ваш продукт.
О шаблонах
За 15 лет мы смогли подвергнуть аналитике более сотни разных файл-справок, инструкций и технических документаций, что дало нам возможность сделать вывод и определить шаблонные разделы, которые могут быть применены к огромному количеству программ, после чего мы интегрировали их в наши образцы. Давайте немного подробнее поговорим о структуре.
Пользовательский интерфейс. Здесь вы можете наглядно показать вашему клиенту интерфейс, ознакомить его со всеми режимами, дополнительными кнопками и.т.д. Если пользователь может персонализировать интерфейс под себя, об этом тоже лучше указать именно в этом разделе.
Типовые задачи. Здесь нужно максимально подробно познакомить пользователя со всеми основными возможностями программы и детально описать ряд задач и вопросов, которые клиент сможет решить с её помощью. В нашем образце этот блок сформирован из двух подразделов.
В подразделе «Примеры использования» лучше всего рассказать пользователю, как ваш продукт будет решать его вопросы и задачи. Если обобщить, то в этом подразделе вы рассказываете про клишированные проблемы, с которыми сталкивается большинство пользователей. В подразделе «Лучшие практики» лучше разместить максимально полезную информацию о том, как упростить свою работу в программе и как пользоваться ей максимально эффективно.
Особые случаи. Здесь нужно рассказать пользователю про то, какие трудности могут возникнуть и как их решить, выделить часто задаваемые вопросы и дать на них самый доступный ответ. Подразделы: «FAQ» и «Устранение типовых проблем»
Вспомогательная и юридическая информация. Здесь вы размещаете информацию о компании, размещаете контактные данные тех.поддержки, информацию о сотрудничестве, сайт, а также лицензионные соглашения.
Что за софт?
Ну и напоследок, уж извините, но мы назовем название нашей программы и приложим ссылку:
Dr.Explain – программа для создания технической и пользовательской документации.
P.S. Мы будем рады, если наши образцы помогут вам закрыть вопрос и успешно реализовать документацию в своем проекте.
Источник: temofeev.ru
Руководство программиста
Многие люди ежедневно играют в компьютерные игры. Данная ниша в данный момент занята несколькими крупными игроками, однако рынок представляет интерес с точки зрения его емкости, поэтому имеет инвестиции в данную нишу имеют смысл.
Постановка задачи
2.1 Назначение комплекса задач
Целью работы интернет-магазина «Компьютерных игр» является обеспечение пользователей дистанционной возможностью заказывать игры и приложения.
2.2 Описание назначения выходной информации
Назначение выходной информации состоит в том, чтобы предоставить пользователю легальный доступ к выбранной компьютерной игре.
2.3 Периодичность решения и ограничения по срокам выдачи выходной информации
Периодичность решения зависит от особенностей работы пользователя в программе и не ограничивается программно.
Продолжительность решения зависит от:
• скорости работы пользователя;
• параметров быстродействия технических средств.
2.4 В практической части сайта
Пользователь должен добавить интересующие товары в корзину и оформить покупку
2.5 Выходная информация
Выходными данными сайта являются:
• справочная информация об играх.
• информация о результатах правильности ввода платежных данных
• предоставление ссылок и ключей для приобретенных игр
А также практическая информация о:
• промежуточных этапах заказа
• результат неправильного ввода платежных данных
2.6 Входная информация
Сайт получает следующие входные сообщения:
• информация от пользователя
Техническое задание
3.1 Назначение разработки
Получение практических и теоретических навыков разработки интернет-магазина в рамках курсового проекта.
3.2 Основная идея
Реализация интернет-магазина по теме: Розничная продажа компьютерных игр.
3.3 Программное обеспечение, необходимое для реализации проекта
Для программной реализации данного проекта необходим:
· Visual Studio 2015 c компилятором C#
Все эти компоненты уже входят в комплект поставки Visual Studio 2015 Community Edition.
Руководство программиста
Сайт написан, при помощи HTML(структура сайта), CSS(макияж сайта), С#(функциональность сайта).
4.1 Используемые на сайте таблицы каскадных стилей(CSS)
font-family: Cambria, Georgia, «Times New Roman»;
div#header div.title, div.item h3, div.item h4, div.pager a
font: bold 1em «Arial Narrow», «Franklin Gothic Medium», Arial;
border-bottom: 2px solid #111;
Источник: poisk-ru.ru