Board.KolibriOS.org

Уважаемые разработчики!

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

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

_________________

HTML only. Ostal'noe govno. A chem ya chm v Linuxe smotret' budu? Vse viewery CHM pod Linux - govno.

.chm, а .hlp еще чуть лучше. Чистый html плох - нет быстрого поиска по указателю, которым я в основном и пользуюсь (набираешь первые несколько букв функции win api - и справка по ней уже перед глазами).

Halyavin:
Ne zabyvay o userah drugih OS.

3 варианта:
1. pdf - кросплатформенность
2. самописная смотрелка своего формата (бред, но сейчас модно)
3. latex/lyx и экспортируй во что хочешь, собственно я за этот вариант. могу сверстать если всем лень текущию версию в латекс

pdf очень резонно

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

to Camper - см. раздел Разное -> Документация
Я почти сразу в pdf перевёл через ABC Amber Converter.

_________________

camper
Я не совсем согласен - он часто тянет с собой шрифты в теле. По этому часто его вес получается достаточно тяжелый.
Имхо html и txt самые доступные форматы, для любой системы - даже ДОС.
Колибри конечно пока не поддерживает html, но это вопрос времени. Зато TXT и RTF уже можно смотреть.

IMHO всю документация надо разделить на Руководство пользователя и Руководство разработчика. Все статьи включить либо в первый, либо второй документ. Будет удобно скачать всю докуменацию сразу, чем отдельно искать статьи в разных местах.

А мне думается, что нужно документацию переводить в тот формат, который поддерживается многими ОС.Это имхо: HTML,txt и rtf.

Читать, блин, особо не стал посты... тороплюсь, хочу сказать, что в HTML весьма неплохо и кросс-платформенно, хотя и CHM можно читать в линухе. А про поиск - можно поиск на JavaScript замутить, есть даже инструменты-генераторы. А еще можно в PDF - вообще неплохая штука.

Кстати, новый формат - OpenDocument
http://www.odfalliance.org
http://en.wikipedia.org/wiki/OpenDocument_technical_specification
http://books.evc-cit.info/odbook/book.html

Вот...несчастье... почти нажал кнопку "Отправить"....а тут Чубайс привет прислал . Пришлось переписывать заново, оно и к лучшему...

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

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


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

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

Документация предполагается в ХТМЛ с ограниченным числом тегов.

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

_________________
Звиздеть не мешки ворочать