powered by simpleCommunicator - 2.0.51     © 2025 Programmizd 02
Форумы / Разработка информационных систем [игнор отключен] [закрыт для гостей] / Почему пользовательская документация до сих пор ПИШЕТСЯ?
25 сообщений из 25, страница 1 из 1
Почему пользовательская документация до сих пор ПИШЕТСЯ?
    #36846377
junixar
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Хотел выделить именно слово пишется. Почему в проектах пишется пользовательская документация, например для различных АРМ. Почему бы не снять её в виде удобного видео ролика? Где будет шаг за шагом всё показано и рассказано. Точнее это бы было несколько роликов, каждый бы отвечал за собственную часть документации. Так проще внести изменения в документацию.

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

Но ни разу не встречал такой документации. Именно документации, а не ознакомительного ролика.

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

Или может так делают, а просто я не встречал?
...
Рейтинг: 0 / 0
Почему пользовательская документация до сих пор ПИШЕТСЯ?
    #36846468
Фотография iscrafm
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
junixar
Или может так делают, а просто я не встречал?
просто не встречал
...
Рейтинг: 0 / 0
Почему пользовательская документация до сих пор ПИШЕТСЯ?
    #36846486
sudo
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Гость
Скажем так - не ПИШЕТСЯ, а РАЗРАБАТЫВАЕТСЯ :) Но не суть важно...

Видеороликов полно - сейчас лениво искать, но встречал их массу. Фишка в другом: если разрабатывается документация для ПОТРЕБИТЕЛЯ - владельца мобилы, покупателя коробочного софта и пр. - тогда записывайте и прикладывайте к девайсу или софтине любые ролики, бумажное руководство и не понадобится.

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

Кстати, последняя редакция некоторых ГОСТ предусматривает интерактивную документацию в электронном виде. Правда, не совсем понятно, как техник самолета будет шарахаться по лючкам и отсекам борта с ноутбуком, тыкать в кнопки и выполнять на борту регламентные работы?

В общем, интересную тему Вы открыли... Предлагаю отдохнуть и расслабиться . И посмеяться от всей души :)
...
Рейтинг: 0 / 0
Почему пользовательская документация до сих пор ПИШЕТСЯ?
    #36846807
lazovik
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
точно, "просто не встречал"!
ток на вскидку: ISCRA Framework, Восточный экспресс, 1C ...
...
Рейтинг: 0 / 0
Почему пользовательская документация до сих пор ПИШЕТСЯ?
    #36847444
474
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
1. В процессе разработки документации требуется ее много ПРАВИТЬ. Что удобнее делать с текстом.
2. По законодательству некоторых стран к продукту должна быть приложена документация. Сочтут ли соответствующие органы видеоролики документацией - я не в курсе.
3. Тексты писать банально дешевле. Техпис может быть хоть заикой, а для видеороликов нужен диктор, еще и ему платить.
...
Рейтинг: 0 / 0
Почему пользовательская документация до сих пор ПИШЕТСЯ?
    #36847489
KomarovAB
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Есть требования ГОСТ, которым некоторые организации очень любят следовать. А некоторые особо прогрессивные хотят помимо руководства на бумажном носителе получить демо-ролики. Документы потом сдадут в бухгалтерию, как отчетные материалы по проекту, а роликами потом будут реально пользоваться в работе.
Кроме того, эффект от демонстрации руководства пользователя на бумажном носителе сильнее при демонстрации его аудиту, как одного из результатов проекта. Дескать, вот как хорошо подрядчики поработали, смотрите, какое толстое руководство пользователя на неё получилось.
...
Рейтинг: 0 / 0
Почему пользовательская документация до сих пор ПИШЕТСЯ?
    #36848319
ЮВ
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
junixarПочему в проектах пишется пользовательская документация, например для различных АРМ. Почему бы не снять её в виде удобного видео ролика? Где будет шаг за шагом всё показано и рассказано.


Такие видеоматериалы широко используются при дистанционном обучении (через интернет)
в различных учебных курса (т. е. предполагается как-бы разовое их использование - для получения обших навыков работы или для ознакомления с возможностями системы).
Имхо, они малоудобны при использовании их в качестве повседневной эксплуатационной документации, когда требуется быстро найти ответ для решения возникшей проблемы.
...
Рейтинг: 0 / 0
Почему пользовательская документация до сих пор ПИШЕТСЯ?
    #36849421
Ivan Durak
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
А я думал речь в топике о спец. программе которая сама будет создавать документацию к любой системе!!! ..... а тут ролики какие-то
...
Рейтинг: 0 / 0
Почему пользовательская документация до сих пор ПИШЕТСЯ?
    #36849473
Фотография MasterZiv
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
junixar wrote:

> Хотел выделить именно слово пишется. Почему в проектах пишется
> пользовательская документация, например для различных АРМ. Почему бы не
> снять её в виде удобного видео ролика?

некоторые и снимают. Зайди на сайт kdenlive например.
Posted via ActualForum NNTP Server 1.4
...
Рейтинг: 0 / 0
Почему пользовательская документация до сих пор ПИШЕТСЯ?
    #36849722
Фотография iscrafm
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Ivan DurakА я думал речь в топике о спец. программе которая сама будет создавать документацию к любой системе!!! ..... а тут ролики какие-то
и еще сама писать системы
...
Рейтинг: 0 / 0
Почему пользовательская документация до сих пор ПИШЕТСЯ?
    #36849726
Ivan Durak
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
iscrafmIvan DurakА я думал речь в топике о спец. программе которая сама будет создавать документацию к любой системе!!! ..... а тут ролики какие-то
и еще сама писать системы
и сама ими потом будет пользоваться!!
...
Рейтинг: 0 / 0
Почему пользовательская документация до сих пор ПИШЕТСЯ?
    #36851040
ЮВ
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
В продолжение темы.
Отодвинем в сторону технические и психологические проблемы разработки и использования мультимедийной документации и рассмотрим чисто финансовые вопросы.

Чтобы создать ролик, сначала надо все-таки НАПИСАТЬ текст (сценарий этого ролика) и этот текст проверить (протестировать).
Большинство свою работу по документированию на этом завершают.

Чтобы создать ролик (экранизировать текстовый документ- сценарий) надо понести дополнительные трудовые (соответственно, финансовые) затраты:
1 должен быть специалист по созданию роликов, т. е. уметь работать с соответствующим ПО;
2 в отличие от текстовой документации, где иногда можно дать чисто словесное описание (типа: в данном окне будет показан список товаров в заданном ценовом диапазоне), в ролике надо ПОКАЗАТЬ это окно ( использовать закадровый голос нет смысла), т. е. для ролика надо готовить правдоподобную БД (демонстрационную БД) со всей необходимой для визуализации информацией. Разработка, ввод и тестирование такой БД (или материалов для визуализации) – тоже требует дополнительных затрат.

Итак:
Пусть у нас есть некий продукт (скажем, 1С), стоимость которого 0.9 уе.
Стоимость текстовой документации для него – 0.1 уе.
Стоимость медиа документации для него – 0.3 уе

Пусть в продаже есть 3 коробки:
1C-Т: с текстовой документацией 0.9+0.1=1.0 уе.
1C-М: с медиа документацией 0.9+0.3=1.2 уе.
1C-Т/М: с комбинированной 0.9+0.1+ 0.3=1.3 уе.

Какую коробку купит пользователь?
Если вы ответите на этот маркетинговый вопрос,
то получите ответ и на свой вопрос: почему документация ПИШЕТСЯ, а не ЭКРАНИЗИРУЕТСЯ?

Дело в цене, в качестве (или в отсутствии предложения) ?

PS К сведению: экранизация многих произведений с треском провалилась.
...
Рейтинг: 0 / 0
Почему пользовательская документация до сих пор ПИШЕТСЯ?
    #36854711
Bogdanov Andrey
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Вот сейчас закрыл глаза и представил видео ролик с SQL*Reference...
Тоже ведь пользовательская документация.
А если серьезно, то очень слабо представляю себе полноценную документация в виде видео-ролика. Вот ознакомительный или учебный фильм - легко себе представляю. А в документации главное - обеспечить поиск и фильм тут вряд ли поможет.
...
Рейтинг: 0 / 0
Почему пользовательская документация до сих пор ПИШЕТСЯ?
    #36854850
Фотография iscrafm
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Bogdanov Andreyв документации главное - обеспечить поиск и фильм тут вряд ли поможет.
в той, о которой идет речь, поиск далеко не главное
...
Рейтинг: 0 / 0
Почему пользовательская документация до сих пор ПИШЕТСЯ?
    #36854906
Bogdanov Andrey
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
iscrafmв той, о которой идет речь, поиск далеко не главноеА о которой "идет речь"?
У топикстартера сказано "пользовательская документация, например для различных АРМ".
Что в этой документации главное?
...
Рейтинг: 0 / 0
Почему пользовательская документация до сих пор ПИШЕТСЯ?
    #36854996
Фотография iscrafm
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Bogdanov Andreyiscrafmв той, о которой идет речь, поиск далеко не главноеА о которой "идет речь"?
У топикстартера сказано "пользовательская документация, например для различных АРМ".
Что в этой документации главное?
лаконичность, наглядность. Ее главное назначение - представить в удобном для понимания какую-то часть БД. Да и на чтение у людей, которые пользуются этими "АРМ", обычно нет времени. Видеоурок + краткая памятка - это все, что возможно "переварить"
...
Рейтинг: 0 / 0
Почему пользовательская документация до сих пор ПИШЕТСЯ?
    #36855068
Bogdanov Andrey
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
iscrafmВидеоурокНу так я и написал про учебные или ознакомительные фильмы.
Но наличие этого никак не заменяет потребность в документации.
...
Рейтинг: 0 / 0
Почему пользовательская документация до сих пор ПИШЕТСЯ?
    #36855708
ЮВ
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
iscrafm[Да и на чтение у людей, которые пользуются этими "АРМ", обычно нет времени.

В таком случае вам надо разрабатывть "интуитивно понятный интерфейс",
в котором на каждой экранной форме пользователю доступна одна, максимум две возможные и правильные в текущем контексте операции-действия (подсказки, кнопки, пункты меню и т. п.).
...
Рейтинг: 0 / 0
Почему пользовательская документация до сих пор ПИШЕТСЯ?
    #36855766
ЮВ
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
iscrafmлаконичность, наглядность.

Видеоматериалы удобны в том случае, когда пользователь мало знаком со специальной терминологией системы.
В этом случае вместо многословного и малопонятного текста действительно проще продемонстрировать на экране, как это делается (армейское правило: "Делай, как я").
Например, вместо описания, как отремонтировать водопроводный кран
(отвинтите шайбу, снимите маховик, открутите еще что-то, завинтите крон-гайку и т. п. непонятные термины) проще показать, как это делается в натуре.
По этому пути идут всевозможные самоучители, типа
- как самому настелить линолеум;
- как получить максимум удовольствия в сексе;
- как самому обрезать садовые кусты и т. п.
где вместо текстового описания приведены рисунки, иллюстрирующие последовательность выполняемых операций (типа комиксы).
...
Рейтинг: 0 / 0
Почему пользовательская документация до сих пор ПИШЕТСЯ?
    #36855845
Фотография iscrafm
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
ЮВiscrafm[Да и на чтение у людей, которые пользуются этими "АРМ", обычно нет времени.

В таком случае вам надо разрабатывть "интуитивно понятный интерфейс",
в котором на каждой экранной форме пользователю доступна одна, максимум две возможные и правильные в текущем контексте операции-действия (подсказки, кнопки, пункты меню и т. п.).
это безусловно.
...
Рейтинг: 0 / 0
Почему пользовательская документация до сих пор ПИШЕТСЯ?
    #36861124
mcureenab
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
Документация разная бывает. Для видеоролика хорошо подходит руководство, в котором по шагам можно проследить использование программы - запустили, ввели, нажали, увидели и т.п.. Т.е. некий алгоритм или процедуру.

Примеры такой документации я видел.

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

Примеры такой документации я тоже видел.

Ещё можно добавить, что в ряде случаев требуется описывать диаграммы словами. Ведь есть ещё и незрячие, которые впринципе диаграмму не могут видеть, но могут её представить по словестному описанию. Или в браузере отключен показ картинок.
...
Рейтинг: 0 / 0
Почему пользовательская документация до сих пор ПИШЕТСЯ?
    #36900527
sudo
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Гость
ЮВ
В таком случае вам надо разрабатывть "интуитивно понятный интерфейс",

:) Только не забудьте прописать в ТЗ о том, что "пользователь должен обладать понятливостью и интуицией" :)
...
Рейтинг: 0 / 0
Почему пользовательская документация до сих пор ПИШЕТСЯ?
    #36901105
ЮВ
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
sudo
:) Только не забудьте прописать в ТЗ о том, что "пользователь должен обладать понятливостью и интуицией" :)

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

Наивно полагать, что вы выйдете на улицу, поймаете первого встречного, посадите его за компьютер, и он сразу начнет работать с вашей программой.
...
Рейтинг: 0 / 0
Почему пользовательская документация до сих пор ПИШЕТСЯ?
    #36910772
пролетевший
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
iscrafm Да и на чтение у людей, которые пользуются этими "АРМ", обычно нет времени. Видеоурок + краткая памятка - это все, что возможно "переварить"
Во первых, текст гораздо компактнее чем видео - часовой урок уместится на десятке страниц текста, который читается минут пять. Во вторых, никто никогда не усвоит все с одного раза, так что возможность прочитать кусочек, попробовать как это выглядит на реальном приложении - с видео гораздо труднее. Ну и поиск - пользователь хочет уточнить, как выполнить определенную задачу, как ему показать именно нужный фрагмент ?
P.S. Делают такие штуки, я например их никогда не смотрю - времени жалко.
...
Рейтинг: 0 / 0
Почему пользовательская документация до сих пор ПИШЕТСЯ?
    #36911626
ЮВ
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Участник
пролетевшийДелают такие штуки, я например их никогда не смотрю

Как, вы не любите презентации?
...
Рейтинг: 0 / 0
25 сообщений из 25, страница 1 из 1
Форумы / Разработка информационных систем [игнор отключен] [закрыт для гостей] / Почему пользовательская документация до сих пор ПИШЕТСЯ?
Целевая тема:
Создать новую тему:
Автор:
Закрыть
Цитировать
Найденые пользователи ...
Разблокировать пользователей ...
Читали форум (0):
Пользователи онлайн (0):
x
x
Закрыть


Просмотр
0 / 0
Close
Debug Console [Select Text]