LINUX.ORG.RU
ФорумTalks

Покажите годное руководство к ПО


0

1

Написал софтину для своей науки. Её хотят включить в учебный план. Но для этого от меня требуют написать к ней руководство (в электронном виде) и методичку (брошюру).

Никогда подобным не занимался. Как вообще выглядят руководства и методички к ПО, есть нормальные примеры?

★★★★★

Сомневаюсь, что бывают такие «сферические руководства в вакууме», которые всем бы нравились. Так что, пишите лучше так, как считаете нужным.

Eddy_Em ☆☆☆☆☆
()

Проще всего добиться от тех, кто просит, четкого ТЗ: содержание методички, требования, количество скриншотов, формат документа.

ns_ramesses
()

Пиши так, чтобы любой идиот читая твою методичку, мог выполнить всё, что должна делать твоя программа. А то будет конфуз, когда преподаватель не сможет что-то объяснить студентам, потому что не понял, как сделать какое-то действие.

ramon13666 ★★★
()

> требуют

С таким подходом я бы их послал, если не за деньги. Пусть сами пишут.

cipher ★★★★★
()

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

baverman ★★★
()

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

DNA_Seq ★★☆☆☆
()

В аналогичной ситуации я написал туториал. По главе (1-3 абзаца) с несколькими примерами на каждый пункт меню, каждый чекбокс, каждый ключ командной строки, каждое ключевое слово файла конфигурации. На таком уровне, чтобы любой человек, в общих чертах знакомый с клавиатурой, мышью, принтером и внутренней математикой программы, смог бы на ней работать. Имхо, лучший вариант, если в объём методички влезает.

question4 ★★★★★
()

ЕСПД (ГОСТ 19)?

А вообще, есть такой предмет в ВУЗах - Технология Разработки Программного Обеспечения. Там этому учат. Поищи методички/лекции.

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

А вообще, попробуй найти неглупого человека, посади его перед программой и попытайся кратко и понятно объяснить ему, как с ней работать. Если получится - вот тебе и документация.

Uter
()

может использовать что то из темы mind-map? Раз сам не знаешь как писать.

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