реклама на сайте
подробности

 
 
> В чем оформлять документацию?
ataradov
сообщение Oct 17 2007, 06:06
Сообщение #1


Профессионал
*****

Группа: Участник
Сообщений: 1 014
Регистрация: 8-01-07
Из: San Jose, CA
Пользователь №: 24 202



У многих крупных фирм, где выпускается множество документации, эта самая документация оформлена в едином стиле. Так вот может знает кто, что именно они используют?

И что можно порекомендовать использовать для это цели? ТеХ это конечно здорово, но проблемы с таблицами и необходимость все долго затачивать убавляют оптимизм. Желательно что-нибудь работающее из коробки и с простым синтаксисом типа как в wiki.
Go to the top of the page
 
+Quote Post
 
Start new topic
Ответов
Doka
сообщение Feb 15 2008, 15:50
Сообщение #2


Electrical Engineer
******

Группа: СуперМодераторы
Сообщений: 2 163
Регистрация: 4-10-04
Пользователь №: 778



Цитата(Taradov Alexander @ Oct 17 2007, 09:06) *
У многих крупных фирм, где выпускается множество документации, эта самая документация оформлена в едином стиле. Так вот может знает кто, что именно они используют? И что можно порекомендовать использовать для это цели? ТеХ это конечно здорово...
используется принцип разделения содержания текста от того как он будет представлен (аналог таблицы стилей (CCS) для HTML).
В мире технической документации для этого используются специальные стандарты. Мне наиболее продвинутым и прогрессивным показался DocBook.
а ТеХ это совсем не здорово, а вчерашний день. Если сегодня начинать работать с написанием тех.документации, то разумнее остановить свой выбор на _стандарте_ , основанном на XML, как наиболее универсальном и продвинутом языке структурированной разметки текстов.

Цитата(Taradov Alexander @ Oct 17 2007, 09:06) *
И что можно порекомендовать использовать для это цели? ТеХ это конечно здорово, но проблемы с таблицами и необходимость все долго затачивать убавляют оптимизм. Желательно что-нибудь работающее из коробки и с простым синтаксисом типа как в wiki.
если с простым синтаксисом как в Вики - то и возъмите, например, MoinMoin Wiki Engine - там присутствует возможность хранения текстов в формате того же DocBook.


ссылки для lazyusers:
* WikiPedia o MoinMoin
* WikiPedia o DocBook
Go to the top of the page
 
+Quote Post



Reply to this topicStart new topic
1 чел. читают эту тему (гостей: 1, скрытых пользователей: 0)
Пользователей: 0

 


RSS Текстовая версия Сейчас: 24th August 2025 - 21:25
Рейтинг@Mail.ru


Страница сгенерированна за 0.01421 секунд с 7
ELECTRONIX ©2004-2016