Разница между учебником и руководством

В Diátaxis сильно различаются учебные пособия и руководства. Это различие, которое часто не делается; на самом деле, наиболее распространенная связь между учебник и руководство.

Итак: в чем разница между учебниками это и как управлять? Почему это важно? И почему они путаются?

Это хорошие вопросы. Начнём с последнего. Если различие действительно так важно, почему оно не очевиднее?

Что у них общего

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

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

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

Важно то, что нужно пользователю

Diátaxis настаивает на том, что в документации важны потребности пользователя, и, обращая на это внимание, мы можем правильно различать учебные пособия и руководства.

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

Учебник служит потребностям пользователя, который находится на учебе. Обязанностью является Чтобы обеспечить успешный опыт обучения. Руководство «Как» служит потребностям пользователя, который работает. Обязанностью является Помочь пользователю выполнить задачу. Это совершенно разные потребности и обязанности, и именно поэтому важно различать учебные пособия и руководства: учебные пособия - ориентированный на обучение, а руководства - ориентированный на задачи.

В учебе и на работе

Мы можем рассмотреть это с точки зрения реального примера. Допустим, вы в медицине: врач, тот, кто должен приобрести и применить практические, клинические навыки своего ремесла.

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

В исследовании

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

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

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

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

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

Но, Вы зашиваете свою первую рану. И вы будете возвращаться к этому уроку снова и снова, и постепенно ваше пренебрежение превратится в уверенную практику. Вы приобретете базовые компетенции. У вас будет Учимся делать.

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

На работе

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

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

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

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

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

Понимание различия

Различие между уроком в медицинской школе и клиническим руководством - это различие между учебником и руководством.

Цель учебного пособия - помочь ученику приобрести базовые компетенции.

Целью руководства является помочь уже компетентному пользователю правильно выполнить определенную задачу;.

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

Как управлять направляет работу пользователя.

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

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

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

Руководство может и должно содержать предполагать знакомство.

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

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

Учебник Устраняет неожиданное.

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

Путь учебника следует одной линии. Он не предлагает выбора или альтернатив..

How-to Guide обычно будет вилкой и ветвью, описывающий различные маршруты к одному и тому же месту назначения: Если это, то это. В случае… альтернативный подход заключается в…

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

Как управлять Нельзя обещать безопасность; часто есть только один шанс сделать это правильно.

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

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

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

В качестве руководства можно предположить, что Пользователь задает правильные вопросы в первую очередь.

Учебник Подробнее об основных вещах - где делать вещи, куда их ставить, как манипулировать объектами. Он обращается к воплощенному опыту - в нашем медицинском примере, как трудно нажимать, как держать реализацию; в учебном пособии по программному обеспечению, это может быть где ввести команду или как долго ждать ответа.

Руководство опирается на это как неявное знание - даже телесное знание.

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

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

Учебник Преподает общие навыки и принципы, который позже может быть применен ко множеству случаев.

Пользователь, следующий инструкциям, делает это для выполнить конкретную задачу.

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

Основной и продвинутый

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

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

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

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

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

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

То же самое в документации программного обеспечения: учебник может представить что-то сложное или продвинутое. И руководство может охватывать то, что является основным или хорошо известным. Разница между ними заключается в необходимости их обслуживания: Исследование пользователя или Их работа.

Безопасность и успех

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

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

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

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