Можно найти в мануале

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

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

Введение

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

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

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

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

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/

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

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

Категория:
Что такое?

– Автор:
Игорь (Администратор)

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

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

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

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

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

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

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

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

Здравствуйте, уважаемые читатели блога: My-busines.ru. Из содержания
предлагаемой вашему вниманию статьи вы сможете узнать о том, что такое мануал.

Что это такое

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

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

Для чего нужен

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

Формат

Наиболее распространенными являются следующие форматы: PDF, Word, HTML. Рассмотрим каждую из этих разновидностей форматов более подробно.

PDF-формат наиболее распространен, потому как он является межплатформенным. Изначально данный формат был создан фирмой Adobe Systems с использованием специального языка PostScript. Наиболее подходящей программой для открытия данного формата является Adobe Reader.

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

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

Как
составить (написать, сделать) мануал

Написание грамотного мануала включает в себя следующие этапы:

1. Указание темы. В границах и сфере темы необходимо быть предельно внимательным и точным;
2. Определение аудитории, для которой составляется (новички, профессионалы, люди со средними знаниями, будут ли изучать самостоятельно или же коллективно);
3. Выбор количества разделов;
4. Выбор названий разделов;
5. Выбор логической структуры изложения материала. Взаимосвязь разделов должна определяться исходя из последовательности действий;
6. Составление словаря терминов, если планируется использование специальных жаргонизмов. Его необходимо будет обновлять по мере написания;
7. Определение тем, которые требуют дополнительного исследования. Если вы не уделите подготовке мануала должного внимания, то от него не будет абсолютно никакой пользы. По этой причине очень важно закончить проведение различного рода дополнительных исследований до того, как вы приступите к написанию;
8. Определение структуры каждого из разделов;
9. Организация логической последовательности каждой секции и каждого раздела, постепенно сужая границы темы.

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

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

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

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

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

Проверять готовый мануал лучше всего в следующей
последовательности:

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

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