Интерактивная документация. Размышления.

[aterentiev]

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

Comments

[yajohn]

wiki?

[aterentiev]

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

[gray_bird]

Майкрософтовская справка?

[aterentiev]

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

[zorand]

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

[aterentiev]

Я не против написать хорошую доку, как минимум, стараюсь ее таковой делать. Проблема в том, что ее никто не читает, или читают "по диагонали". А потому, появилась идея все сделать... user-friendly, чтоль... чтобы не боялись, а делали. Для нового поколения дока. Автоподстраивающаяся под нужды читателя. Но, наверное, это идеализм...

[zorand]

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

[aterentiev]

A меня больше интересует передача знаний "на места", чтобы человек, увидев ключевое слово, не бросался к телефону, вызванивая меня, а вспоминал о доке.

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