Board.KolibriOS.org

Official KolibriOS board
It is currently Mon Jul 22, 2019 11:06 am

All times are UTC+03:00




Post new topic  Reply to topic  [ 31 posts ]  Go to page 1 2 3 Next

В каком формате Вы хотели бы видеть документацию по KolibriOS?
txt 20%  20%  [ 13 ]
html 42%  42%  [ 27 ]
chm 22%  22%  [ 14 ]
rtf 6%  6%  [ 4 ]
Другой 9%  9%  [ 6 ]
Total votes: 64
Author Message
PostPosted: Sat Mar 11, 2006 4:30 pm 
Offline

Joined: Fri Jan 06, 2006 6:05 am
Posts: 102
Уважаемые разработчики!

В каком формате Вы хотели-бы видеть документацию для KolibriOS

Выскажите здесь ваши мнения по этому поводу.

_________________
Image


Top
   
 Post subject:
PostPosted: Sun Mar 12, 2006 4:47 pm 
HTML only. Ostal'noe govno. A chem ya chm v Linuxe smotret' budu? Vse viewery CHM pod Linux - govno.


Top
   
 Post subject:
PostPosted: Mon Mar 13, 2006 5:03 pm 
.chm, а .hlp еще чуть лучше. Чистый html плох - нет быстрого поиска по указателю, которым я в основном и пользуюсь (набираешь первые несколько букв функции win api - и справка по ней уже перед глазами).


Top
   
 Post subject:
PostPosted: Mon Mar 13, 2006 9:29 pm 
Halyavin:
Ne zabyvay o userah drugih OS.


Top
   
 Post subject:
PostPosted: Wed Mar 15, 2006 9:40 pm 
3 варианта:
1. pdf - кросплатформенность
2. самописная смотрелка своего формата (бред, но сейчас модно)
3. latex/lyx и экспортируй во что хочешь, собственно я за этот вариант. могу сверстать если всем лень текущию версию в латекс


Top
   
 Post subject:
PostPosted: Thu Mar 16, 2006 6:25 pm 
Offline
User avatar

Joined: Thu Oct 13, 2005 12:00 pm
Posts: 299
pdf очень резонно


Top
   
 Post subject:
PostPosted: Thu Mar 16, 2006 6:28 pm 
Offline
User avatar

Joined: Thu Oct 13, 2005 12:00 pm
Posts: 299
соображения такие, пдф конвертится из опен офисс и из мастдай офисс, все легко набирать и вставлять, можно делать гиперссылки, формулы и т.д.


Top
   
 Post subject:
PostPosted: Thu Mar 16, 2006 7:02 pm 
Offline

Joined: Fri Jan 06, 2006 6:05 am
Posts: 102
to Camper - см. раздел Разное -> Документация
Я почти сразу в pdf перевёл через ABC Amber Converter.

_________________
Image


Top
   
 Post subject:
PostPosted: Sat Mar 18, 2006 12:21 am 
camper
Я не совсем согласен - он часто тянет с собой шрифты в теле. По этому часто его вес получается достаточно тяжелый.
Имхо html и txt самые доступные форматы, для любой системы - даже ДОС.
Колибри конечно пока не поддерживает html, но это вопрос времени. Зато TXT и RTF уже можно смотреть.


Top
   
 Post subject:
PostPosted: Sat Mar 18, 2006 4:52 pm 
Offline

Joined: Sun Jun 19, 2005 7:08 pm
Posts: 41
IMHO всю документация надо разделить на Руководство пользователя и Руководство разработчика. Все статьи включить либо в первый, либо второй документ. Будет удобно скачать всю докуменацию сразу, чем отдельно искать статьи в разных местах.


Top
   
 Post subject:
PostPosted: Thu Mar 23, 2006 1:31 pm 
А мне думается, что нужно документацию переводить в тот формат, который поддерживается многими ОС.Это имхо: HTML,txt и rtf.


Top
   
 Post subject:
PostPosted: Thu Aug 31, 2006 1:41 pm 
Читать, блин, особо не стал посты... тороплюсь, хочу сказать, что в HTML весьма неплохо и кросс-платформенно, хотя и CHM можно читать в линухе. А про поиск - можно поиск на JavaScript замутить, есть даже инструменты-генераторы. А еще можно в PDF - вообще неплохая штука.


Top
   
 Post subject:
PostPosted: Thu Aug 31, 2006 7:31 pm 
Offline

Joined: Mon Apr 10, 2006 7:22 am
Posts: 76
Кстати, новый формат - OpenDocument
http://www.odfalliance.org
http://en.wikipedia.org/wiki/OpenDocument_technical_specification
http://books.evc-cit.info/odbook/book.html


Top
   
PostPosted: Sun Oct 07, 2007 12:49 pm 
Вот...несчастье... почти нажал кнопку "Отправить"....а тут Чубайс привет прислал :). Пришлось переписывать заново, оно и к лучшему...

Смысл в чем. Ни в коем случае нельзя делать доки в одном формате....Это по личному опыту (занимаюсь этим). Необходимо (именно необходимо) выбрать как минимум ДВА формата, причем широкораспространенные, и один из них выбрать из разряда "обычным_юзверем_не_ковыряемый".....
Это поможет избежать многих мелких неприятностей, особенно когда ось станет более-менее зрелым продуктом.
Тут наиболее банальная связка ХТМЛ-Дежавю....
В доке ОБЯЗАТЕЛЬНО должен в самом начале указываться релиз системы (в каждом файле) и т.д. и т.п....
Доки для юзверей ОБЯЗАТЕЛЬНО должны быть отделенными от док для кодеров и быть предельно простыми и исключать двойное толкование (это самое трудное... бывает такого наслушаешься, что волосы дыбом не только на голове)...

Хороший пример доки для начинающего юзверя (только не кидать в меня камнями) книжка от Win95. Самое основное, с картинками (типа комиксы) и FAQ...


В принципе, если запущу на своем агрегате (испытательном), и разберусь в оси,то посмотрю... бог даст - приведу к "корпоративному" виду... но это не раньше конца ноября :(..

P.S. Надо прежде всего четко сформулировать политику составления манов...


Top
   
PostPosted: Sun Oct 07, 2007 2:10 pm 
Offline
Designer
User avatar

Joined: Thu Jan 25, 2007 3:33 pm
Posts: 5053
Документация предполагается в ХТМЛ с ограниченным числом тегов.

Та даже пофиг на формат, главное прога, которая бы умела читать этот формат. А её нет!
(Тайнипад неплох, но не для серьёзной документации - например, должны быть хотя бы гиперссылки и кнопочки туда\назад)

_________________
Через тернии к звездам


Top
   
Display posts from previous:  Sort by  
Post new topic  Reply to topic  [ 31 posts ]  Go to page 1 2 3 Next

All times are UTC+03:00


Who is online

Users browsing this forum: No registered users and 2 guests


You cannot post new topics in this forum
You cannot reply to topics in this forum
You cannot edit your posts in this forum
You cannot delete your posts in this forum
You cannot post attachments in this forum

Search for:
Jump to:  
Powered by phpBB® Forum Software © phpBB Limited