Pull to refresh

Comments 12

Дочитал до конца с одной мыслью «когда же будет про апдейт хелпа», а все самое вкусное оставили на следующую статью…
Хочется написать о всех нюансах и не упустить ничего. Но тогда многие не станут читать до конца. Поэтому было принято решение поделить информацию на смысловые блоки.
мы этот хелп читали только для того чтобы узнать как безболезненно обновлять наши хелпы! :)
выкладывайте продолжение
Поскольку никто не сказал (что очень странно для хабралюдей), что «1% — про меня!», то скажу я — «1% — про меня!»

P. S. Нет, честно!
По-моему, тот факт, что 99% не читают и не любят читать — говорит о кризисе жанра. Как-то совсем по-другому надо писать справку.
Очень важно то, как составлена документация. Документация может быть составлена так, что её интересно будет читать. На мой взгляд проблема 99% в том, что 99% документации пишется сухо и без расчёта на то, что кто-то будет читать. Делается ради того, чтобы была и не несёт никакой ценности.

Хорошо составленная документация читается легко. Кроме того, медиа контент никто не отменял.
Я что-то подобное и хотел сказать.
Когда речь идет о документации API — тут ее обычно и вовсе разработчики большей частью пишут. Язык здесь маловажен, Хотя хорошее, доходчивое введение в технологию все равно очень ценно. И тоже — редкость.
Но когда речь о пользовательской документации… 99% состоит из перечисления очевидных вещей. Типа «кнопка „детали“ открывает окно деталей».
Увы, не в каждом TFM есть чего R.
Неинтересно составленная документация, это в действительности не важно.
Я как программист, который работал над множеством вендорных библиотек могу сказать, что важно, чтобы документация в принципе существовала. Не важно, если она читается не интересно и нудно. Единственное что важно, так это чтобы она представляла актуальную информацию (!) по системе с которой приходится работать.
Документация в первую очередь это источник информации, на которую читатель опирается, как на единственный верный источник информации, это его опора в освоении чего-то нового.
А сделать из скучного текста не скучный это уже работа совсем других парней
В статье есть одна полезная мысль — HELP должен писаться сторонним человеком, с позиций пользователя, а не представлений разработчика о своём продукте.
Честно говоря, задрали уже руководства пользователя, а ля 1С: Бухгалтерия, представляющие собой перечень функций, кнопок и экранов. А дальше — как хочешь!
Лично я — ЗА руководства напоминающие путеводитель или сценарий. С точно известной точкой входа, траекторией, и конечным результатом.
Sign up to leave a comment.