Page 1 of 1

Документация программы.

PostPosted: Sat Mar 06, 2010 10:57 am
by 2rist
Готов попробовать задокументировать работу с программой, единственное что опыта такого нет, так что потребуется координация)
Некоторые вещи в программе не совсем интуитивно понятны, в частности установка новых звуковых словарей, с которой сам столкнулся. Поэтому неплохо бы их описать в документации или сделать хотя бы FAQ с пошаговыми инструкциями.

PS: программа понравилась и вижу в ней потенциал, поэтому хочется ее как-то поддержать.

Re: Документация программы.

PostPosted: Sat Mar 06, 2010 10:43 pm
by ikm
Отлично. Я за :) Писать можно (но не обязательно) в местной wiki. Если есть вопросы - задавайте.

Re: Документация программы.

PostPosted: Sat Apr 03, 2010 11:04 am
by 2rist
Извиняюсь за столь долгое бездействие. Сейчас вроде появилось свободное время, так что начну заниматься)
Для начала думаю стоит определиться со структурой содержания. Хочу взять за образец, структуру в документации MultiLex и соответственно услышать мнение по такому решению)

Re: Документация программы.

PostPosted: Sat Apr 03, 2010 11:21 am
by ikm
Нормально, выглядит неплохо.

p.s. Я там пока суд да дело начал писать FAQ в английской части.

Re: Документация программы.

PostPosted: Sun Apr 18, 2010 8:42 am
by 2rist
Внес первые изменения в Руководство_пользователя
Неплохо бы дать возможность загружать файлы, чтобы можно было снабдить текст необходимыми скриншотами. Пока разместил только ссылки на изображения, думаю по имени ссылки будет интуитивно понятно, каких скриншотов не достает)

ikm, хотелось бы попросить тебя(надеюсь, не против что на "ты"?:)) поправил оглавление. Все таки взгляд пользователя и разработчика отличается) Это облегчит написание остальных разделов.

PS "Обращение ко всем": Я думаю, если кто-то еще из заинтересованных в улучшении данной программы, присоединится к написанию документации, дело пойдет быстрее ;)

Re: Документация программы.

PostPosted: Thu Apr 22, 2010 12:04 pm
by ikm
На берлиозе очень маленькая дисковая квота у проектов -- что-то в районе 50mb. Картинками эта квота будет занята очень быстро. Поэтому картинки имеет смысл разместить на каком-нибудь хостинге изображений типа imageshack.us.

Re: Документация программы.

PostPosted: Mon Apr 28, 2014 11:19 am
by logiz
Добрый день. Существует ли документация кода программы? Или вся документация сводится к комментариям в коде?