kvisaz (kvisaz) wrote,
kvisaz
kvisaz

Categories:

Почему документация плохо работает

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

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

Выяснилось, что подробное описание всех опций - хорошо, но недостаточно. А проблема-то вот в чем:

2019-10-08-doc-tangram-web.png

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

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

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

Лайфхак - на образцах учиться проще, чем на энциклопедиях.
Tags: программирование
Subscribe

  • Оливер Сакс

    Оливер Сакс, нейрофизиолог и писатель, умер в 82 года. Вот, на днях, 30 августа 2015 года. Это был первый писатель, открывший для меня удивительный…

  • Ти Ви Рэмэн

    "В 14 лет индийский мальчик T. V. Raman потерял зрение из-за глаукомы. Вместо простого кубика Рубика ему пришлось собирать кубик Рубик Браиля (где…

  • Оседлавшие небо или Как выжить при падении с 10 километров

    Купил мартовскую "Популярную Механику" (№3 за 2010), а там такая статья - "Падайте на здоровье или руководство по выживанию при падении с…

  • Post a new comment

    Error

    default userpic
    When you submit the form an invisible reCAPTCHA check will be performed.
    You must follow the Privacy Policy and Google Terms of use.
  • 3 comments