Автор Гілка: системи створення документації  (Прочитано 3367 раз)

Відсутній 235

  • Кореспондент
  • ***
  • дописів: 238
  • Карма: +0/-0
Порадьте:
Потрібно створити користувацько-адміністративну документацію для існуючого проекту:
  • кількість авторів ~8 розробників й стільки ж з відділку підтримки - потрібна колективна робота
  • ОС - win, тому гадаю можливий варіант веб інтерфейсу для створення документації
  • сильно бажаний експорт в чистий HTML (для експорту в CHM чи ще там куди) й можливо PDF дял друку
  • можлива двомовність, візуальний
Розглядаю варіанти:
1. DocBook
   + експорт практично куди завгодно
    - практично немає відносно якісного просто доступного (безкоштовного) візуально редактора. З усіх перебраних, найкраще виглядає лише Altova Authentic 5 DE
    - потрібно додатково систему контроля версій, відповідно й інерфейс до нього
2. Wiki  (виглядає більш привабливим)
   + веб інтерфейс, пошук
    -  невізуальні редактори (переважно)
    -  переважно відсутній експорт вибраного дерева документації (ну не надибав толком ніде)
як варінти реалізації вікі - це MoinMoin, що в доволі працюючій беті відразу дає візуальний інтерфейс; Trac - що дозволяє об'єднати багато також розробницькіх задаж з відслужковуванням запитів й тд (але потрібно буде прикрутити морду); співробітник щось розбираєтеся також в Twiki
3. Якісь groupware системи (доки не переглянув добре)

Що краще використати, звісно навіть окрім цих варіантів й власне що краще підійде?
« Змінено: 2005-11-27 21:41:33 від uran »
Олександр Приймак |  Google Web Toolkit

Відсутній Володимир Лісівка

  • Адміністратор ЩОДО
  • Видавець
  • *****
  • дописів: 3820
  • Карма: +11/-0
  • Програміст
Re: системи створення документації
« Відповідей #1 : 2005-11-28 20:47:06 »
Для редагування DocBook:

Цитата
Vex - A Visual Editor for XML

Vex is an editor for XML documents. The "visual" part comes from the fact that Vex hides the raw XML tags from the user, providing instead a wordprocessor-like interface. Because of this, Vex is best suited for "document-style" XML documents such as XHTML and DocBook rather than "data-style" XML documents.

http://vex.sourceforge.net/

Ми на проекті використовуємо Trac - там ще багато чого треба зробити.
[Fedora Linux]

Відсутній 235

  • Кореспондент
  • ***
  • дописів: 238
  • Карма: +0/-0
Re: системи створення документації
« Відповідей #2 : 2005-12-06 22:23:18 »
Цитата
Vex - A Visual Editor for XML
ох, дякую - та саме його я й використовував після знайомства з DocBook.
Мінуси - немає візуалізації таблиць, вставки малюнків. Тобто не зовсім повноцінний на мою думку поки, але переспеспективна штука. Й ще дивно працює вибір тегів, звикав відносно довго. Перебравши всі варіанти й тому для юзерів видивився той варіант. Але вже звертаюся в сторону вікі-документації.

Цитата
Ми на проекті використовуємо Trac - там ще багато чого треба зробити.
так, переглянув його вздовж, поки відбракував :|

MediaWiki/TWiki - з кучою плагінів, як варівнт для документування.

Й підшуковую пошуковик з індексацією окрім веб всіляких ворд/ексель/пдф. mnoGoSearch?
Олександр Приймак |  Google Web Toolkit

Відсутній Дмитро Редчук

  • Кореспондент
  • ***
  • дописів: 104
  • Карма: +0/-0
Re: системи створення документації
« Відповідей #3 : 2006-10-24 12:00:38 »
Розглядаю варіанти:
1. DocBook
[ ... ]
2. Wiki  (виглядає більш привабливим)

MoinMoin, до речі, може генерувати XML.
«Критика має бути конструктивною. Інакше вона деструктивна» ©
Щось не так? — Зроби так.