Wiki-подібний інструмент для написання специфікацій та документації [закрито]


9

Я шукаю wiki або wiki-подібну систему для написання та управління специфікацією та документацією для програмного проекту.

Я знаю, що доступно багато вікі-реалізацій, але чи є такі, які особливо добре підходять для такого роду завдань?

Насправді це не повинно бути вікі, а лише системою, яка дозволяє легко писати та переглядати характеристики та документацію, а також підтримує трасування змін.


1
Ви використовуєте спеціальну платформу? Як, наприклад, TFS від Microsoft?
Saeed Neamati

Відповідно до запитання @Saeed, яку інфраструктуру вже має ваша команда / організація для управління знаннями та обміну? Крім того, які ваші поточні процеси написання специфікацій та документів?
Томас Оуенс

Відповіді:


6

Ми використовуємо LaTeX та SVN. Оскільки документи LaTeX - це лише текстові файли, він добре поєднується з контролем версій, на відміну від деяких бінарних або частково-бінарних форматів.

Ви отримуєте всі переваги (і недоліки, правда,) контролю версій, до яких ви звикли, використовувати його зі своїм кодом.

LaTeX потребує невеликих налаштувань (для визначення власних стилів / класів), але, як тільки ви це зробите, це дуже добре - ви можете сконцентруватися виключно на вмісті, а не на його презентації (а не на спокусі постійно налаштовувати, як ви WYSIWYG), але все-таки отримайте гладкий професійний PDF-документ в кінці.


4

Особисто мені дуже подобається Tiddly Wiki .

Він має досить повний синтаксис wiki, являє собою єдиний html-файл і добре працює з різними веб-браузерами без необхідності роботи сервера.

Він навіть має розширювану архітектуру плагінів, яка дозволяє додавати плагіни, щоб робити всілякі цікаві речі, такі як шифрування загадок або додавання виносок.


3

Для платформи Microsoft інтеграція TFS (Team Foundation Server) з SharePoint - це саме те, що ви шукаєте. Створюючи новий командний проект, ви можете вибрати шаблон, що охоплює майже кожен аспект процесу розробки програмного забезпечення. Він дає вам портал, на якому ви можете визначати членів команди, призначати їх ролі та дозволи безпеки, завантажувати, ділитися та редагувати документи та технічні характеристики, пов’язані з вашим проектом, і робити багато інших цікавих речей з ним.

Для інших платформ я думаю, що ви можете використовувати щось на кшталт GitHub (хоча я в цьому не впевнений).


0

Для особистого проекту (існуючого лише в моєму ПК) я використовую Wiki in Jar . Раніше я працював з Redmine (він також має систему відстеження помилок і SCM)


0

Ви можете спробувати Sphinx , а документи перевірятимуться на обрану вами інфраструктуру управління джерелом. Це має переваги керування джерелами та відносно легку мову розмітки, reStructuredText , яку легко вивчити та досить добре інструментувати для перетворень (у HTML, PDF та ін.).

Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.