New user registration is currently disabled due to spam abuse / Регистрация новых пользователей в настоящее время приостановлена из-за злоупотреблений спаммерами

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

Ветка для общения разработчиков и координации разработки

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

Postby 2rist » Sat Mar 06, 2010 10:57 am

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

PS: программа понравилась и вижу в ней потенциал, поэтому хочется ее как-то поддержать.
Last edited by 2rist on Sun Mar 07, 2010 10:18 am, edited 1 time in total.
2rist
 
Posts: 6
Joined: Sat Mar 06, 2010 9:59 am

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

Postby ikm » Sat Mar 06, 2010 10:43 pm

Отлично. Я за :) Писать можно (но не обязательно) в местной wiki. Если есть вопросы - задавайте.
ikm
Автор GoldenDict
 
Posts: 1595
Joined: Wed Feb 04, 2009 10:40 am

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

Postby 2rist » Sat Apr 03, 2010 11:04 am

Извиняюсь за столь долгое бездействие. Сейчас вроде появилось свободное время, так что начну заниматься)
Для начала думаю стоит определиться со структурой содержания. Хочу взять за образец, структуру в документации MultiLex и соответственно услышать мнение по такому решению)
2rist
 
Posts: 6
Joined: Sat Mar 06, 2010 9:59 am

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

Postby ikm » Sat Apr 03, 2010 11:21 am

Нормально, выглядит неплохо.

p.s. Я там пока суд да дело начал писать FAQ в английской части.
ikm
Автор GoldenDict
 
Posts: 1595
Joined: Wed Feb 04, 2009 10:40 am

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

Postby 2rist » Sun Apr 18, 2010 8:42 am

Внес первые изменения в Руководство_пользователя
Неплохо бы дать возможность загружать файлы, чтобы можно было снабдить текст необходимыми скриншотами. Пока разместил только ссылки на изображения, думаю по имени ссылки будет интуитивно понятно, каких скриншотов не достает)

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

PS "Обращение ко всем": Я думаю, если кто-то еще из заинтересованных в улучшении данной программы, присоединится к написанию документации, дело пойдет быстрее ;)
2rist
 
Posts: 6
Joined: Sat Mar 06, 2010 9:59 am

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

Postby ikm » Thu Apr 22, 2010 12:04 pm

На берлиозе очень маленькая дисковая квота у проектов -- что-то в районе 50mb. Картинками эта квота будет занята очень быстро. Поэтому картинки имеет смысл разместить на каком-нибудь хостинге изображений типа imageshack.us.
ikm
Автор GoldenDict
 
Posts: 1595
Joined: Wed Feb 04, 2009 10:40 am

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

Postby logiz » Mon Apr 28, 2014 11:19 am

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


Return to Разработка

Who is online

Users browsing this forum: Google [Bot] and 1 guest