LINUX.ORG.RU
ФорумTalks

Посоветуйте методологию написания мануала к софтине

 


1

1

Сабж. Софтина с гуём.

Upd: Интерфейс интуитивно-понятный, но софтина будет использоваться в т.ч. старичками с кафедры, которые без мануала забьются в угол. Алсо для написания мануала, т.к. он будет печатным, я собираюсь использовать LaTeX. Вообще, есть кое-какие наработки годовой давности, но неужели нет каких-то годных conventions? Или просто мануала для софтины с гуём, который кажется вам оптимальным.

★★★★★

Последнее исправление: Obey-Kun (всего исправлений: 4)

Ответ на: комментарий от beastie

Какой бы не был интуитивно-понятный интерфейс, большинство пользователей-дебилов все равно его не осилит.

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

Пощечина же. Ядреный и непостижимый язык.

Eddy_Em ☆☆☆☆☆
()

Шутки в сторону — качаешь любой мануал к какой-нибудь железке с веб-интерфейсом и по образу и подобию со скриншотами и ничего не значащими объяснениями клепаешь свой мануал.

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

А картинки с таблицами он умеет? А для печати пойдёт? См. мои наработки манула в первом посте, что-то подобное можно сделать в groff?

Obey-Kun ★★★★★
() автор топика
Ответ на: комментарий от Obey-Kun

Там этот стиль особенно распростаннён. Например: Netgear SRX5308. Для софта подобных мануалов не встречал.

beastie ★★★★★
()
Ответ на: комментарий от Obey-Kun

Ядрена сковородка! При чем здесь картинки с таблицами? Мы же о мануале говорим, который командой man вызывается…

Eddy_Em ☆☆☆☆☆
()
Ответ на: комментарий от Obey-Kun

см. обновление оп-поста

Посмотрел, не вчитывался, но вполне нормально. По-больше бы скриншотов, дабы старички разобрались.

И не только описание интерфейса, но и описание стандартных действий (с картинками).

beastie ★★★★★
()
Последнее исправление: beastie (всего исправлений: 2)
Ответ на: комментарий от Obey-Kun

много ты видел man'ов к программам с GUI?

Встречал. Правда, не все этим обременяются (скоты!). Иной раз наберешь что-нибудь вроде man GUI-tool, а тебе — шиш с маком! Хреново.

Eddy_Em ☆☆☆☆☆
()
Ответ на: комментарий от Obey-Kun

Почти двести страниц А4 мана FVWM хороший пример или так себе?

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

Ну не нативный я больше, не нативный. ☺ Выше уже поправили.

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

Что, дожил до того, что уже и выпить нельзя?

Eddy_Em ☆☆☆☆☆
()

- ГОСТ 19.001-77 – единая система программной документации.

- ГОСТ 19.101-77 – виды программ и программных документов.

- ГОСТ 19.102-77 – стадии разработки программ и программной документации.

- ГОСТ 19.105-78 – требования к оформлению программных документов, комплексов и систем независимо от их назначения и области применения.

- ГОСТ 19.105-78 содержит полный перечень документации, которая должна сопровождать законченный программный продукт.

P.S.: Наработка на 3 с минусом. В суть не вникал, только оформление.

robot12 ★★★★★
()
Последнее исправление: robot12 (всего исправлений: 2)
Ответ на: комментарий от beastie

А як яго правильно писати? О! Оплеуха!

Ляпас! Правильно писати ляпас.

f1xmAn ★★★★★
()

Документация в пдф — говно, мне кажется. Лучше сделать вики.

Ok
()

ответь на вопрос, зачем нужен этот софт, что он делает. какие есть возможные пользовательские сценарии? опиши их, с экранами обязательно. при необходимости можно рассмотреть всякие workflow/dataflow.

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

подщётчина

Що?

Это когда ладошкой по гландам

Siado ★★★★★
()

вообще-то существует ГОСТ и РД

да, стандарты родом из 80-х годов, из СССР. но практически все серьёзные конторы по-прежнему используют именно эти нормативные и руководящие документы. ну наверное, точка входа - это РД 50-34.698-90. там, в частности, есть пункт 3.4. Руководство пользователя.

да, может создаться впечатление, что РД из далёкого прошлого и не нужен, но в нём есть смысл, если прочитать и задуматься. всё очень просто перекладывается на нынешние реалии.

taker
()

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

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

Я оттуда и взял идею, очень уж понравилась.

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