LINUX.ORG.RU

Пользовательской документации тред

 


0

1

Как грамотно составить пользовательскую документацию на десктопное приложение для специалиста с нетехническим складом ума?

Ссылки, может, есть какие?

Deleted

Последнее исправление: rht (всего исправлений: 1)

Лучше просто пользоваться здравым смыслом и логикой. Представь, что ты пользователь, и пиши. Где какая кнопка, как их жать и т.д. И без заумных слов. Как вариант - посади рядом жену и попроси ее подумать за тебя =) Ну или любого другого просто хомяка.

Zhbert ★★★★★
()
Ответ на: комментарий от Zhbert

Наверное так и надо, да.

И без заумных слов.

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

Deleted
()
Ответ на: комментарий от Deleted

Там есть sqlite и графики.

Зачем про скулайт знать простому пользователю? Замени просто на «база данных». Ну а графики - они и в Африке графики.

Zhbert ★★★★★
()
Ответ на: комментарий от Zhbert

Ну а графики - они и в Африке графики.

Придётся, видимо. вносить изменения в программу, чтобы легенда была более наглядной.

Замени просто на «база данных».

Админиь нужно будет (добавлять, удалять). Ладно, покумекаю.

Deleted
()

Картинки. Стрелочки. Цифорки.
Стрелочки на картинках должны вести от цифорки к цифорке.
Не забудь в углу E-mail оставить.

Deleted
()
Ответ на: комментарий от Zhbert

Где какая кнопка, как их жать и т.д.

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

massimus ★★★
()

Найти техписа и допросить

TEX ★★★
()
Ответ на: комментарий от massimus

последовательность действий для достижения нужного результата.

А чем это отличается от «где какая кнопка и как их жать»?
«Для достижения такой-то цели нажмите на такой-топ анели такую кнопку...». Примерно по такому пути, например, сделан хелп в солидворксе. Очень удобно.

Zhbert ★★★★★
()
Ответ на: комментарий от Deleted

Админиь нужно будет (добавлять, удалять).

От всей души надеюсь, что не составлением запросов. Если для юзверя бд выглядит как список или типа того, пусть и будет списком. И т. п.

Xenesz ★★★★
()
Ответ на: комментарий от Deleted

база данных

По тексту можно использовать база данных, а в описании самого продукта сделать ссылку что в качестве оной используется sqlite И как вариант описывать каждую функцию ПО по мере написания

metalheart90
()
Ответ на: комментарий от Harald

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

metalheart90
()
Вы не можете добавлять комментарии в эту тему. Тема перемещена в архив.