:: urbansheep (urbansheep) wrote,
:: urbansheep
urbansheep

  • Music:

Как человечно описывать онлайн-сервисы // Документация и почти-кейсы

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

«

“Вас упоминают”. Например: пользователь Бла внес информацию о встрече с вами и оставил следующий комментарий: бла-бла-бла, читать дальше. [добавить пользователя в контакты] [релейтед информация] [внести встречу в свои записи] [добавить комментарий (фото/видео)]

»

Совмещение действий и описания кажется очевидным только когда их читаешь, но вовсе не когда пишешь. Во время подготовки таких текстов всегда возникает желание рассказать о возможностях и опциях. Вечный бич технических заданий. Когда мне приходилось писать такие вещи, то в какой-то момент я просто плевал на длинные описания разделов с бесконечными повторениями, и переходил на инфоарх-схему: оставляя один абзац „назначение“, список элементов, список основных путей посетителя из этой точки.

В случае со схемой „описание/действия“ всё получается ещё удобнее и компактнее. А чем компактнее уложена информация, тем проще работать с таким техническим описанием — оно небольшое, симпатичное и удобное в работе.

 
 

Subscribe
  • Post a new comment

    Error

    Comments allowed for friends only

    Anonymous comments are disabled in this journal

    default userpic

    Your reply will be screened

    Your IP address will be recorded 

  • 0 comments