Разница между ссылкой и объяснением¶
Объяснение и ссылка относятся к теория половине карты Диатаксиса — они не содержат шагов для руководства читателем, они содержат теоретические знания.
Разница между ними - так же, как в разнице между учебными пособиями и руководствами - разница между приобретение навыков и знаний и его приложение. Другими словами, это различие между исследование и работа.
Простое различие, в основном¶
В основном довольно легко понять, имеете ли вы дело с тем или иным. Ссылка, как форма письма, хорошо понимается; он используется в различиях, которые мы делаем о письме с раннего возраста.
Кроме того, примеры написания сами по себе часто явно одно или другое. Приливная диаграмма с ее таблицами фигур является явно справочным материалом. Статья, которая объясняет, что почему есть приливы и как они ведут себя, является самоочевидным объяснением.
Есть хорошие правила большого пальца:
Если это скучно и незабываемо, вероятно, ссылка.
Список вещей (такие как классы, методы или атрибуты) и таблицы информации, как правило, принадлежат к ссылка.
С другой стороны, Если вы можете себе представить, что читаете что-то в ванной, вероятно, это объяснение (даже если действительно нет учета того, что люди могут читать в ванне).
Представьте, что вы спрашиваете друга, гуляя или выпивая, Можете ли вы рассказать больше о теме? - ответ или обсуждение, которое следует, скорее всего, будет объяснение.
Но интуиция недостаточно надежна.¶
В основном мы можем полагаться на интуицию, чтобы управлять различием между ссылками и объяснениями. Но только в основном - потому что между одной формой и другой довольно легко проскользнуть.
Обычно это происходит при написании справочного материала, который начинает расширяться. Например, вполне разумно включать иллюстративные примеры в ссылку (так же, как энциклопедия может содержать иллюстрации), но примеры — это забавные вещи для развития, и может быть заманчиво развить их в объяснение (используя их, чтобы сказать почему, или показать Что если, или как это произошло).
В результате часто можно найти объяснительный материал, посыпанный в ссылку. Это плохо для ссылки, прерывается и затемняется отступлениями. Но это плохо и для объяснения, потому что не позволяет развиваться должным образом и делать свою работу.
Работа и учеба¶
Настоящий тест, однако, если мы сомневаемся в том, что что-то должно быть ссылкой или объяснением: это то, к чему кто-то обратился бы во время работы, то есть, на самом деле получая что-то сделано, выполняя задачу? Или это то, что им нужно, как только они отойдут от работы и захотят подумать об этом?
Это два очень принципиально разных потребности читателя, которые отражают, как в этот момент читатель стоит по отношению к рассматриваемому ремеслу, в отношениях работа или исследование.
Ссылка - это то, что нужно пользователю, чтобы помочь знаниям и навыкам применять, пока они работают.
Объяснение - это то, к чему кто-то обратится, чтобы помочь им знания и навыки приобретать - «изучение».
Понимание этих двух отношений и удовлетворение потребностей в них является ключом к созданию эффективных ссылок и объяснений.