Мануал что это такое в программировании

Что такое мануал?

Категория:
Что такое?
– Автор:
Игорь (Администратор)

Что такое мануал?В рамках данной заметки, я расскажу вам что такое мануал, а так же некоторые особенности. И начну с определения.

Мануал (Manual) — это, в ИТ сфере, руководство пользователя по использованию какой-либо программы, сервиса и тому подобного. Если говорить простыми словами, то это нечто вроде «инструкции для чайников» или «инструкции по применению».

Зачем нужен мануал? Данный документ обычно содержит подробное описание основных возможностей описываемого объекта (программы, сервиса и т.п.). Кроме того, в него могут входить инструкции для решения типовых проблем, различные нюансы использования и прочее, что только может понадобиться пользователю.

В каких ситуациях применяется термин мануал? Чаще всего слово мануал совмещают с такими словами как «смотри», «читай», «изучай» и подобными. Как бы указывая пользователю, что решение проблемы можно найти в документе и, в ряде случаев, что не стоит пытаться «повесить» свои проблемы на других людей (обычно, из-за лени).

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

Тем не менее, стоит знать, что у данного термина существуют иные значения. Например, под словом «мануал» могут подразумевать клавиатуру органа.

Так же советую ознакомиться с обзором Как правильно задавать технические вопросы.

Понравилась заметка? Тогда время подписываться в социальных сетях и делать репосты!

☕ Понравился обзор? Поделитесь с друзьями!

  • Что такое ЧСВ?

    Что такое ЧСВ?
    Что такое?

  • Что такое бро?

    Что такое бро?
    Что такое?

  • Что такое мб?

    Что такое мб?
    Что такое?

  • Что такое нуб?

    Что такое нуб?
    Что такое?

  • Что такое олдфаг?

    Что такое олдфаг?
    Что такое?

  • Что такое холивар?

    Что такое холивар?
    Что такое?

Добавить комментарий / отзыв

Основы написания мануалов при разработке


Пользовательская документация  —  не самая интересная тема для разработчиков. Однако важно убедиться, что продукт не причинит вреда пользователям  —  ни физически, ни в плане повреждения их собственности. Утрата данных, выход из строя оборудования и прочие проблемы могут привести к серьезным судебным претензиям. 

Эта статья не сделает вас профессиональным техническим писателем, равно как не охватит всех законных требований к продукту. Тем не менее она даст примерное представление о том, как создавать полноценную документацию, которая поможет пользователям эффективно взаимодействовать с софтом. 

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

Определить целевую группу

Прежде чем начать писать документацию, необходимо определить, для кого она будет предназначена? Кто будет использовать продукт?

Я не стану объяснять, как проводить анализ целевой группы, так как вы можете легко найти необходимую информацию в интернете. В целом, вам нужно просто представить потребности пользователей и понять, как они будут отражены в руководстве к продукту. 

Для лучшего понимания приведу несколько примеров того, как целевая группа может повлиять на содержание руководства.

  • Если аудитория состоит из людей старшего поколения, то используйте хорошо читаемый разборчивый шрифт. 
  • Если же она представлена разработчиками, то нет необходимости объяснять базовые шаги в ОС Windows. 
  • Если вы пишите для дислексиков, то делайте предложения короткими и используйте простые термины.

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

Понять, как будет использоваться продукт 

Когда с целевой группой пользователей вы определились, нужно понять, как именно они будут работать с продуктом. Хорошая документация всегда должна ориентироваться на пользователя, а не просто объяснять функционал. Технические писатели создают мануалы, ориентированные на задачи, а не на функционал.

Вот два примера, которые помогут выделить отличия этих двух принципов.

  • Функционально-ориентированное название главы: “Использование мастера экспорта”.
  • Задачно-ориентированное название главы: “Экспортирование данных проекта”.

В данном случае мастер экспорта  —  это просто инструмент для выполнения задачи, а именно экспорта данных. Пользователи не знают, что для экспорта данных им нужно использовать мастера экспорта. Они будут искать, ориентируясь на задачу, а не функцию.

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

В этом случае рекомендуется спросить себя следующее.

  • Что будут делать пользователи с продуктом?
  • Почему они его используют? Какова их цель?

Лучше всего будет пригласить группу пользователей и провести с ними обсуждение. Целью будет определить их задачи и, в идеале, дать им название на языке пользователей. Если же возможности собрать группу реальных пользователей у вас нет, то есть еще одно решение: пригласить коллег, которые по своей работе близко с ними связаны (например, продакт-менеджеров, проектных менеджеров, маркетологов или специалистов поддержки).

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

Начните с инструкций

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

Инструктивная глава дает пользователю пошаговый алгоритм действий.

Советы по написанию инструктивных глав

Вот несколько советов, которые нужно учесть при написании инструктивных глав.

  • Начинайте название главы с существительного. Пример: “Экспортирование данных проекта”.
  • Структурируйте инструктивные главы в виде нумерованного списка. Каждый этап задачи должен представлять один пункт списка.
  • Инструктивная глава не должна превышать 11 шагов. Большее число шагов излишне ее удлинит, снизив удобство чтения. Если в итоге у вас получается длинная глава, то поделите ее на подразделы.
  • Описывайте шаги в императивной форме. Пример: чтобы экспортировать данные проекта, нажмите на значок “Экспорт”.
  • Не предоставляйте подробной информации о возможности продукта или о том, как он работает. Вместо этого сосредоточьтесь на выполняемых пользователем шагах. Главы с сопутствующей информацией относятся к следующему этапу руководства.

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

Пример инструктивной главы

Добавление сопутствующей информации

После написания инструкций спросите себя: “Что нужно знать пользователям (чего они еще не знают) для выполнения всех этих инструкций?”

Перед каждой инструктивной главой добавляйте концептуальные. Они будут объяснять особенность ПО, необходимую для выполнения инструкций. В примере “Экспортирование данных проекта” одна глава может быть посвящена мастеру экспорта и поддерживаемым форматам данных.

Инструктивная и концептуальная информация строго разделяются, упрощая для пользователя поиск нужной информации. Помните, что большинство пользователей не читают все руководство, а ищут конкретную тему, используя функцию поиска или службу поддержки.

Советы по написанию сопутствующей информации

Вот несколько советов, актуальных при написании концептуальных глав.

  • Не добавляйте в заголовках описательные приставки типа “О…” или “Сведения о…”. Называйте только сам принцип или функцию, которую хотите описать. Почему? Когда вы ищете что-либо по теме в интернете, то не вводите “Сведения о затмении”. С большей вероятностью вы будете искать по запросу “Затмение”. Когда пользователи ищут принципиальную информацию, они действуют аналогично, например пишут запрос “Мастер экспорта”.
  • Добавляйте только такие концептуальные главы, которые помогут пользователям выполнить инструкцию. Вероятно, вы вложили немало усилий в разработку бэкенда, необходимого для работы конкретной функции. При этом сложности, связанные с ее реализацией, не должны отражаться в документации. Единственное исключение  —  когда пользователю нужно знать эти детали для выполнения инструкций. Перед написанием концептуальной главы всегда спрашивайте себя: “Зачем пользователю нужно это знать?”.
  • Связывайте описательные главы с соответствующими инструктивными и наоборот.

Пример главы с сопроводительной информацией

Добавление справки

Последний компонент  —  это справка. Справочные главы содержат информацию для поиска в виде таблиц. В этих таблицах вы описываете графический интерфейс пользователя (GUI) и API.

Этот тип информации предназначен для пользователей, которые знакомы с принципом в общем, но хотят почитать о параметре, поле записи, выпадающем меню или других элементах GUI. В первую очередь такие справочные главы ориентированы на опытных пользователей, хотя иногда их читают и новички.

Советы по написанию справочной информации

  • Заголовок справочной главы должен совпадать с элементом GUI или описываемой в ней функцией, например “Диалоговое окно мастера экспорта”.
  • Обязательно называйте элементы GUI так же, как они названы в самом GUI. Пользователи зачастую копируют названия элементов и вставляют их в строку поиска.
  • Подумайте, какая информация поможет пользователю, ищущему конкретный элемент GUI. Возможно, он как-то связан с другими элементами GUI или ограничениями. Задокументируйте их в справочной главе.

Примеры справочных глав


Вот и все  —  у вас получился мануал, ориентированный на нужды пользователей. Конечно же, для создания образцовых мануалов еще многое нужно изучить. Однако с помощью этих основ вы уже сможете выстроить неплохую документацию.

Я не стал детально объяснять, почему рекомендую структурировать и писать руководства именно так. Моей целью было научить вас делать это максимально быстро. 

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

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

Помните, что мануалы мы читаем не ради удовольствия, а от необходимости.

Читайте также:

  • 5 вредных привычек неэффективных программистов
  • Как написать хороший README: краткий курс
  • Успешный релиз ПО: распространенные ошибки перед запуском продукта

Читайте нас в Telegram, VK и Яндекс.Дзен


Перевод статьи Andreas D.: How To Write Manuals as a Developer

Что такое хороший мануал к ПО?

Время на прочтение
1 мин

Количество просмотров 3.7K

Хотелось столько всего рассказать, столько всего написать, что теряешься от созерцания горизонтов тем, мыслей, соображений.

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

С ростом проекта WELLtime команда наших разработчиков встала перед несколькими вопросами. Развивающийся программный продукт дал почву для реорганизации линейки предложений, изменения приоритетов между его модулями и подал много интересных идей.

Но это были одни из основных ожидаемых направлений деятельности.

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

Сделать продукт не просто, но написать к нему грамотный мануал не легче.
Возникло много интересных идей и рациональных предложений, но хотелось бы спросить у хабролюдей, что для них является показателем хорошего мануала к ПО?

Как написать руководство пользователя программы или сайта — инструкции, советы, помощь, программное обеспечение

Журавлев Денис

Что такое руководство пользователя и для чего его создавать

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

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

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

Общие советы по созданию пользовательской документации

Перед тем как приступить к созданию руководства, нужно определиться с некоторыми важными моментами. Например, определить, для кого вы его пишете? Кто его будет читать — рядовые пользователи, для которых важны базовые функции продукта, или люди, которым нужны особые, нечасто используемые функции программы/сервиса.

После этого важно подумать о том:

  • Где пользователь будет к нему обращаться: дома, на работе, в машине?
  • Как часто он будет его просматривать?
  • Насколько объективно сложен для понимания продукт?

Из этого можно сделать вывод, насколько интенсивно пользователь будет работать с документацией, а значит уже можно выбрать между сжатым «справочником» или объемным «путеводителем» Также важно, чтобы руководство писал профессионал, знающий продукт. Так что по возможности делегируйте написание техническому специалисту или аналитику, у которого есть полное представление о всех тонкостях продукта.

Определившись со всеми представленными пунктами, станет понятнее, какой нужно использовать стиль изложения, какого объема написать текст. Но помните, что излишне стилистически окрашенные слова мешают пользователю добраться до сути. Так что лучшим вариантом в большинстве случаев будет нейтрально-формальный стиль. Пишите так, чтобы пользователь вас понял. Постарайтесь по возможности избегать технических терминов, но проанализируйте — не сделает ли полное отсутствие терминов ваше руководство бесполезным?

Структура руководства пользователя

После того как вы ответили на предыдущие вопросы, создайте структуру руководства. У любого хорошего «путеводителя» хорошая и логичная структура. Начните с оглавления. Информативное содержание поможет читателю легко ориентироваться в документе.

В первом разделе желательно рассказать общую информацию о программе:

  • Для чего создан продукт.
  • Какие задачи он решает.
  • Какие основные выгоды от использования для клиента.

В следующем разделе можно указать основные элементы пользовательского интерфейса. Пользователю будет трудно разобраться в софте, если он не поймёт для чего служат различные элементы интерфейса, или он не разберётся в основных режимах работы ПО. Опишите понятным языком предназначение экранов и окон.

Создайте раздел, где расскажете о наиболее эффективных способах применения продукта для решения типовых задач. Какие цели стоят перед клиентом, и как ваша программа/сервис помогает достичь их. Укажите информацию о том, как быстро и продуктивно пользоваться программой.  

Ни одно руководство не обойдется без таких разделов как: «Частые вопросы» и «Устранение типовых проблем» В них разбираются вопросы и проблемы, с которыми часто сталкиваются пользователи. Для заполнения данного раздела вам скорее всего понадобятся уже готовые отзывы клиентов. Если у вас абсолютно новый продукт, вы можете предугадать проблемы ваших клиентов либо на первое время не включать данный пункт в ваше руководство.  

Иногда технические писатели забывают о важном моменте в руководстве пользователя — контактная информация. Этот раздел поможет пользователям связаться с вами, даже если у них нет никаких вопросов и руководство полностью закрывает все их потребности. Клиент может дать совет, поделиться опытом или предложить выгодное вам сотрудничество.

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

Но как создать руководство пользователя, если пишешь его впервые? Или что делать, если руководство пользователя нужно постоянно обновлять и дорабатывать? Или нужны особые функции, которых нет в традиционных текстовых редакторах, например, в MS Word.

Одним из популярных инструментов для создания качественного руководства является программа Dr. Explain (https://www.drexplain.ru), в которой уже есть готовые шаблоны руководств пользователя с готовой структурой разделов и в которой удобно обновлять документацию, как бы часто эти обновления не происходили.

Видео-обзор основных возможностей программы Dr.Explain

Удобной особенностью инструмента является возможность экспортировать один и тот же документ в форматы: HTML, CHM, PDF. Простой и понятный интерфейс сам подскажет, как быстро просмотреть документ в различных форматах и настроить его под вывод в эти форматы.

Любой проект в Dr.Explain вы можете создать с нуля или импортировать уже существующую документацию, например из формата MS Word, HTML или CHM-файла, и буквально за несколько минут создать из нее онлайн-помощь, файл справки в формате CHM, или документ в формате PDF.  

Экспорт руководства пользователя в различные форматы

При создании руководства важно опираться на заранее составленный план. Дерево проекта в Dr.Explain поможет структурировать документ по вашему усмотрению. Вы можете добавлять, удалять перемещать разделы и переименовывать их. Для каждого раздела вы можете определить, в какой формат он будет экспортироваться. Также в работе удобно использовать статусы готовности разделов.

Структура разделов руководства пользователя

У программы свой собственный редактор, оптимизированный под работу со сложной документацией. Основные функции редактора вынесены в компактный тулбар. Это — управление стилем текста, форматирование абзацев, вставка ссылок, изображений, видео, таблиц и списков, а также вставка специальных объектов. Dr. Explain экономит время и силы своих пользователей. Разработчики документации часто сталкиваются с проблемой многократного использования одного и того же фрагмента текста и прибегают к очевидным решениям — «Ctrl+c», Ctrl+v». Dr.Explain предлагает решение по повторному использованию контента — текстовые переменные. Это решение экономит время, когда нужно много раз использовать один и тот же текст, особенно, который может периодически изменяться — например, версия документируемой системы.

Переиспользование контента в пользовательском руководстве

Многие российские компании сталкиваются с тем, что руководство пользователя нужно писать согласно ГОСТ 19 и ГОСТ 34. Dr.Explain активирует поддержку требований ГОСТ фактически одним кликом. Программа автоматически сформирует структуру обязательных разделов и установит требуемые параметры страницы, стили абзацев, списков и заголовков.

Создание руководства пользователя по ГОСТ 34 и ГОСТ 19

Часто техническим писателям при документировании пользовательского интерфейса приходится снабжать изображения пояснительными выносками. Для таких случаев программа поддерживает специальные графические объекты — аннотированные экраны. Чаще всего аннотируются скриншоты программ и страниц веб-сайтов. Уникальной особенностью Dr.Explain является автоматическая аннотация изображений, получаемых при захвате экранов с окнами программ или сайтов. Программа анализирует структуру окон и добавляет пояснительные выноски ко всем значимым элементам.

Аннотирование скриншотов пользовательского интерфейса в руководстве пользователя

Кроме того, Dr.Explain позволяет нескольким авторам одновременно работать над проектом с использованием сервиса www.tiwri.com, учетную запись на котором можно создать бесплатно за пару минут. При внесении правок одним автором сервис блокирует редактируемые разделы проекта для изменения другими авторами.  По окончании редактирования изменения отправляются на сервер, и блокировка снимается. Так несколько человек могут одновременно работать над различными разделами проекта без риска помешать друг другу.  

Многопользовательская работа над проектом

Попробовать режим многопользовательской работы в Dr.Explain можно даже с бесплатной лицензией. Вы можете создать общий проект и полноценно работать с ним в многопользовательском режиме до семи дней.

Почему компании выбирают Dr.Explain для создания руководств пользователя

Павел Свиридов

Павел Свиридов, профессиональный военный, полковник, создатель астрологической системы «Вега Матрица»

«Только программа Dr.Explain обладала всеми необходимыми возможностями. А главное — она давала простор для творчества. Можно было выбрать цветовую гамму, вид и форму служебных элементов, настраиваемые шаблоны. Это позволило мне сохранить стилевое единство документации и самой программы. Ну, и конечно, полуавтоматическая обработка материала существенно облегчает и ускоряет работу по созданию хелпа.

Обучение работе в Dr.Explain было наглядным и сделано возможностями самой программы, что безусловно повлияло на мой выбор в ее пользу».

Руководство пользователя к программе Вега Матрица

Прочитать полный кейс компании «Вега Матрица вы можете перейдя по ссылке


Наталья Обухова

Наталья Обухова, бизнес-аналитик компании CRM Expert

«По классике жанра был пилотный проект на двух фаворитах (Dr.Explain и HelpNDoc) и муки выбора.

Через неделю справка была полностью готова. Конечно, если мы набивали ее «с нуля», за это время мы бы не успели. Мы просто конвертировали все бумажные инструкции во внутренний формат программ, изменили каталогизацию и организовали систему гиперссылок.

Сначала фаворитом выбора была другая система, но решающим фактором в пользу Dr.Explain стал возглас человека, выполняющего основную часть работы по переносу текста: «Вжух! И вся структура документа перенеслась в файл справки». Функция импорта в Dr.Explain отработала на ура и сэкономила кучу времени.

Также очень подкупил дизайн веб-справки, который формируется Dr.Explain, и красивый способ организации подписей к окнам нашей системы. В Dr.Explain это называется «Аннотирование экрана».

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

Прочитать полный кейс компании CRM Expert


Николай Вальковец

Николай Вальковец, разработчик компании 2V

«Мы значительно сократили время работы техподдержки с новыми клиентами на этапе подключения. Раньше требовалось проводить онлайн презентации и видео конференции для новых клиентов, объясняя особенности программы. Сейчас же, один раз постаравшись максимально подробно всё описать, мы избавили себя и нашу техподдержку от этой работы. Нам импонирует простота программы и скорость работы. Можно быстро редактировать, добавить новые пункты в документацию, сохранить в формате HTML и выложить на сайт».

Руководство к программе 2V Стоматология

Прочитать кейс компании V2  


Подытожим

Создание и написание хорошей пользовательской документации — это труд, который требует много времени и усилий. Но если успешно справиться с задачей, можно навсегда получить лояльных и довольных клиентов. Не забывайте о том, что недовольство от некачественного руководства может быть спроецировано пользователем на сам продукт и повлиять на дальнейшие решения о его выборе. Пользовательская документация должна стать персональным и незаменимым помощником. Используя Dr. Explain, вы сможете быстро создать качественное руководство пользователя, которое будет помогать пользователям разбираться в продукте, а вам позволит сосредоточить свои силы на более важных задачах — разработке и продвижении программного продукта.

Скачать Dr.Explain с неограниченной по срокам возможностью бесплатной работы можно по адресу: https://www.drexplain.ru/download/

Успешных вам разработок!

Смотрите также

  • Dr.Explain — инструмент для создания мобильной версии пользовательской документации к программным продуктам
  • Шаблоны файлов помощи, руководства пользователя программного обеспечения или сайта, шаблон базы знаний — бесплатные шаблоны и примеры пользовательской документации

Материал из PhpWiki.

Перейти к: навигация, поиск

Содержание

  • 1 Введение
  • 2 Как читать мануал?
  • 3 ПОМОГИТЕ! Не могу там ничего найти!
  • 4 На что стоит обратить внимание
  • 5 Часто задаваемые вопросы
  • 6 Дополнительная информация

Введение

Многие начинающие программисты (не зависимо от изучаемого ими языка программирования) считают, что «профи» не читают мануал (или читают его крайне редко), потому что знают все наизусть. Это заблуждение. Без сомнения, люди с опытом помнят из мануала больше, чем начинающие. Но это не основной плюс, который приходит с опытом. Запомнить все невозможно, и мануал имеет свойство обновляться вместе с тем, что он описывает – какой толк с того, что этот «профи» помнит устаревшую информацию?

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

Как читать мануал?

Мануал читают четырьмя способами:

  1. Если вы хотите знать больше, чем знете сейчас. Независимо от того, знаете ли вы много, знаете очень мало или ничего не знаете. Особенно полезен, если вы еще ничего не знаете или знаете очень мало. Читайте мануал так, как если бы вы читали какую-нибудь сказку. Просто ходите по страницам мануала и читайте все, что еще не читали раньше. Выделите 5% своего рабочего времени на такое чтение – это время вам потом с лихвой окупится.
  2. Если вы решаете какую-то задачу и для ее решения нужно использовать какую-то функцию, но вы не знаете какую. Или вы знаете, какую функцию можно было бы использовать, но вам кажется (или, может, так оно и есть), что эта функция – не совсем то, что вам нужно. Найдите эту функцию (если не знаете, где ее описание, то воспользуйтесь способом, описанным ниже). И прочитайте все, что касается этой функции, в том числе ссылки в разделе «смотрите также» и комментарии пользователей. Если найденная функция не совсем вам подходит, то, возможно, ссылка на искомую функцию содержится в «смотрите также». В комментариях пользователей содержится много полезной информации, особенно по всяким нестандартным задачам. Как говорил один из моих шефов: «если перед вами возникла какая-то задача, то не сомневайтесь – до вас ее как минимум человек десять уже решали – просто найдите решение». Для такого чтения много времени не требуется и, следовательно, планировать его тоже не нужно.
  3. Вы знаете, какая функциональность вам нужна, и знаете где про нее прочитать. Хотя названия функций и классов вы не знаете, но время поиска резко сокращается — вам надо только открыть мануал на нужном разделе и пробежать глазами пару страниц. Удивительно, но многие пренебрегают таким способом мануала, хотя он не занимает ни времени, ни «постоянной памяти» мозга.
  4. Вы знаете, какая функция нужна для решения вашей задачи, но забыли ее имя и/или перечень/назначение аргументов или какую-нибудь особенность ее работы. В этом случае о чтении речь как бы и нет: вы просто «подсмотрели» какую-нибудь мелкую деталь. Это самый простой вариант и, думаю, он не нуждается в комментарии.

Многие начинающие программисты убеждены, что даже если опытный программист и читает мануал, то только последним способом (потому что забыл какую-нибудь мелкую деталь). Это заблуждение. Даже очень опытные программисты (и особенно они) читают мануал всеми четырьмя способами.

ПОМОГИТЕ! Не могу там ничего найти!

Итак, у вас появилась проблема.

При этом вы, честно говоря, ни черта в этом не понимаете и даже не подозреваете, с какой стороны подойти. Я не буду спрашивать вас, зачем тогда вы этим занимаетесь. Бывает. Итак, возьмем как пример PHP Manual – отличный пример хорошо структурированного и почти идеального мана. Откроем его. И что мы видим? Нет, можете не обращать внимания на имена-фамилии составителей (хотя не мешало бы и их запомнить). Я про то, что находится ниже и называется Table of Contents.

Надеюсь, вы себе представляете, что это. По-русски это звучит как «содержание». Теперь наступает время тяжелых размышлений: что нам, собственно, надо в мануале? И действительно, что мы там забыли? Возьмите свою проблему и подумайте, какие области из перечисленных в Table of Contents она затрагивает и какие области может затронуть решение.

Неплохо вообще-то понимать по-английски, хотя бы читать (да, перевод мануала уже есть, но он УЖЕ устарел, а за английским маном следит и обновляет ежедневно не один десяток людей). Подумали? Просмотрите главы мануала, которые вы выделили. Неплохо было бы еще просмотреть названия функций (обычно они «говорящие») и краткие описания рядом с ними. Обычно этого хватает, чтобы получить какие-то зацепки. От них можно уже отталкиваться дальше. Возьмем пример: всем уже приевшийся «постраничный вывод из базы».

Если подумать, то становится ясно, что: вывод каким-то образом связан с текстом, точнее со строками, еще точнее – со String functions. Если мы выводим что-то из базы, то надо искать в разделе, который ей посвящен (если у вас MySQL, то вам в MySQL Functions); проблема явно связана с математикой (арифметикой) – нам надо ДЕЛИТЬ общее количество на страницы.

Таким образом, шаг за шагом, мы приходим к функциям echo(), mysql_query(), mysql_fetch_*() (мы прочли ман и поняли, что mysql_result() не стоит использовать), мы посмотрели в Mathematical Functions и нашли там функцию ceil(), а также (по аналогии с многими языками и по подсмотренным в мане примерам) нашли конструкцию while(). Что нам еще надо? Ничего. Нам УЖЕ ничего не надо. Мануал – под рукой, пишем скрипт.

Что-то не работает – смотрим, почему, выводим переменные (print_r() нам поможет в этом), проверяем синтаксис функций и правильность нашего выбора. Вы спросите: «А где же тут форум? На каком этапе он появляется и зачем он вообще нужен?». А форум появляется только тогда, когда вы будете испытывать сложность в АЛГОРИТМЕ или сомневаться в оптимальности вашего алгоритма. Что же делать, если вы вообще себе алгоритм не представляете? Тут масса вариантов: бросьте, это не ваше; доучитесь, а потом беритесь; купите себе книжку, попробуйте почитать все сначала; прочтите, наконец, мануал. Запомните одно: в мануале есть МАССА ПРИМЕРОВ. Вам всего-то надо уметь искать и читать (надеюсь, что copy/paste вы сделать сможете?).

Ну вот вы чего-то не нашли в мануале (скорее всего плохо искали). И что делать? Да ничего. Сесть, успокоиться, открыть свой любимый поисковик и набрать ключевую фразу: «Как сделать так, как я хочу?». Уверяю вас – там будет масса попаданий.

Нет? Тогда открываем форум, жмем на ссылочку ПОИСК В ФОРУМЕ и пишем туда ключевые слова. Обратите внимание, что на форуме PHP-клуба при поиске находятся только те топики, в которых есть слова ровно в той форме, как вы задали в строке поиске. Например, если вы будете искать фразу типа «как хранить деревья», то в качестве результата появятся топики, в которых есть слово «как», слово «хранить» и слово «деревья». Если в форуме есть топик, в котором есть слова «как» и «хранить» и «дерево», но нет слова «деревья», то этот топик в результат не войдет. Пробуйте разные словоформы. Если есть топик, в котором есть слова «хранить» и «деревья», но нет слова «как», то этот топик тоже не будет показан в результате. Но ведь слово «как» Вас не интересует, не так ли? Используйте только самые важные слова. Чтобы искать по части слова, используйте звездочку: поиск по «дерев*» найдет все топики, в которых есть слова, начинающиеся на «дерев»: «дерево», «деревья», «деревянный», но не «древообразный».

Не нашли? Ну что ж, пишите в форум.

Внимание!

Перед тем, как писать в форум, обязательно прочтите правила форума и сделайте еще одну очень важную вещь – задайте себе тот вопрос, который вы хотите задать в форуме. 49% людей не могут толком задать вопрос, еще 49% могут ответить на него сами, но почему-то этого не делают, остальные 2 процента – это реальные вопросы. В последнее время эти 2 процента все чаще превращаются в вопросы типа «Я не умею читать, покажите мне строку, в которой написано «мама мыла раму»! Плииииз!»

Не стоит к ним присоединяться. Лучше пойдите, попейте кофе/чай/пиво/водку и подумайте. Если вы ПРАВИЛЬНО прочли ман, то ответ ДОЛЖЕН к вам прийти, надо только чуть-чуть подумать. Когда будете бить себя по лбу и кричать «Как же я сразу не догадался?!», не забудьте поставить на стол чашку/кружку/рюмку.

На что стоит обратить внимание

  • Раздел «См. также». Многие умные люди работали над мануалом и написали в этот раздел страницы сходные или связанные с текущей страницей. Если вы немного промахнулись (нашли функцию округления числа вниз, а нужно округление с заданной точностью) — нужная вам функция может оказаться именно в этом разделе.
  • Новые термины. Во-первых, они поднимают вашу эрудированность в предмете, что для программиста аналогично кубикам преса. Во-вторых, по ним можно искать. И находить.
  • Коментарии к мануалу. Например, онлайновый мануал по PHP снабжен средством коментирования, где написанно много полезных советов в стиле cookbook (кулинарной книги).

Часто задаваемые вопросы

  • Я знаю имя функции, но никак не могу найти ее описание.

Скачайте документацию в формате “Windows HTML Help” (*.chm):
http://www.php.net/download-docs.php

Запустите ее, на вкладке «Указатель» наберите имя функции и нажмите Enter.

Описание функции также можно найти, набрав в браузере:

php.net/имя_функции

Например,
http://php.net/mysql_fetch_assoc

  • Что делать, если я не умею искать?

Шаг 1. Искать так, как если бы Вы умели искать. Забудьте слово «не умею».

Шаг 2. Выполнится автоматически после того, как вы много раз проделаете шаг 1. Умение придет с опытом.

  • Я часто что-нибудь ищу, но так и не научился толком искать. Почему?

Есть такая пословица: без труда не выловишь и рыбку из пруда.

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

Вон, даже в «Матрице» обучение идет по ускоренной программе: вставили дискетку, пять секунд и вы уже умеете управлять вертолетом. Идея о таком способе обучения не на пустом месте возникла – она взята из жизни. Не забывайте о том, что в реальной жизни такого не бывает!

Если вы еще не научились – учитесь дальше!

  • Что делать, если я не умею пользоваться расширенными возможностями поиска?

Нужно прочитать документацию по расширенным возможностям поиска – там все написано.

  • Что делать, если я не знаю, где описаны расширенные возможности поиска?

Нужно найти то место, где описаны расширенные возможности поиска. Поиском для этого, кстати, пользоваться не требуется – просто посмотрите внимательно на страницу с формой для поиска, где-нибудь должна быть ссылка.

  • Я ищу-ищу, но ничего не могу найти. Что делать?

Искать дальше. Попробуйте другие способы, другие ключевые слова, другие поисковые системы. Кстати, на форуме РНР-клуба можно искать не только при помощи формы поиска, которая есть на самом форуме, но и при помощи Яндекса и при помощи Google! Искать можно не только на форумах PHP-клуба, но и на других сайтах.

Находка, выдумка, смекалка вам помогут.

  • Читать мануал как сказку? Разве такое возможно – ведь сказка – это интересно, а мануал – это так скучно!

Вы можете представить себе профессионального врача, у которого любимое увлечение – игра в футбол, а медициной он занимается только по принуждению? Представьте, что этот врач будет делать вам операцию. Что вы чувствуете?

Если вы считаете, что читать мануал – это скучно, то откажитесь от программирования вообще.

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

  • Вы сравниваете нас с начинающими программистами. Вы хотите нам доказать, что мы ничего не умеем?

Я сравниваю не вас, а начинающих программистов с опытными. Если вы приписали себя к начинающим, а не к опытным, то вы сделали это самостоятельно.

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

Нет ничего плохого в том, если вы только начинаете, еще ничего не знаете и не умеете. Плохо, если вы не хотите знать и не хотите уметь.

  • Почему некоторым не нравится фраза: «ПОМОГИТЕ! Не могу там ничего найти!»

Потому что фактически эта фраза означает: «Не хочу больше искать. Найдите за меня!» Так и хочется добавить: «Я пришел. Обслуживайте меня!»

Дополнительная информация

http://www.php.net/docs.php

Главный вход в документацию по PHP.

http://dev.mysql.com/doc/

Главный вход в документацию по MySQL. Есть возможность закачать документацию в разных форматах для локального использования. Если прокрутить страничку пониже, то можно найти ссылку на документацию на русском языке.

http://html.manual.ru/

Это не перевод скучной спецификации и не попытка написать учебник. Задача справочника – коротко и ясно описать действие всех элементов языка HTML, которые вы можете без опаски использовать при создании Internet-страниц, не боясь, что какая-то версия какого-либо браузера сделает вам неприятный сюрприз.

Иначе говоря, здесь представлен «классический» HTML, употребляемый профессиональными web-разработчиками. И ничего лишнего.

Все теги, не описанные в этом справочнике, можете смело выбросить в помойку.

http://webclass.polyn.kiae.su/konspekt.htm

Хорошие интерактивные учебники по JavaScript, CSS, заголовкам HTML.

http://msdn.microsoft.com/

MSDN – официальная документация по всем продуктам Microsoft, бесплатно доступная в режиме online.

Кроме всей прочей документации, здесь расположена самая полная документация по JavaScript, HTML, CSS. Только для Microsoft Intenet Explorer, и в основном на английском языке.

Для чего нужен форум?

Вы задали вопрос, а вас, вместо того, чтобы дать вам ответ, послали читать мануал? Вы считаете, что на форуме с вами обращаются несправедливо? Никто не захотел вам помочь, и теперь вы мучаетесь вопросом «а для чего же тогда вообще нужен этот форум?» Прочтите внимательно эту статью, и вы поймете, почему с вами происходит то, что происходит.

Copyright YuriPopoff, http://phpclub.ru/faq/

ремонт дверных замков. Со скидкой оформили государственный диплом техникума на этом сайте

Понравилась статья? Поделить с друзьями:
  • Без верного руководство
  • Ямз 236м2 руководство по ремонту
  • Ямз 236м2 руководство по ремонту
  • Донна препарат для суставов инструкция цена таблетки
  • Уролайф форте капсулы инструкция по применению цена