Легкая программа для составления документации web-проекта?

Question

[dnv777]

Подскажите программу(или онлайн сервис) для ведения документации по web-сайту.

За 6 лет проект достаточно раздулся, и уже стало тяжело держать в голове все зависимости.

Комментариев в коде уже явно не достаточно.

Пока работаю один, поэтому такие громадины как Microsoft Project не подходят

что нужно:

выстроить диаграммы связи + подробное описание к каждому блоку(Plain Text не подходит)

пробовал Visio, с диаграммами нормально, но вот с документацией не удобно


И буду благодарен если подскажите ресурсы как составлять документацию для web-проекта/базы данных

Сколько в инете искал, все ориентировано на крупные многопользовательские проекты, а нужно что-то с чего можно было быстро начать, не тратя много времени на изучение.


Документация пишется в основном для меня и начальника.

Answer 1

[ComodoHacker]

Начните с простой Wiki. Например в Trac (может уже используете) весьма неплохая. Для диаграмм можно прикрутить Graphviz плагин.

Для БД рекомендую SchemaSpy. Умеет рисовать схамы с помощью того же Graphviz.

Answer 2

[dnv777]

Определился что хочу, но пока не нашел решений.
Хочется построение диаграммы и чтоб при клике на блок слева/снизу в панели отображался editable(rich text) description.

с диаграммой к базе справляется и SQL Server, да и куча других прог, но вот со второй частью требования(панель с удобным description). Пока искал, нашел ряд красивых, продвинутых решений, может кому интересно:
Creately — описание к листу как и хотел Rich Text Edit, но описание к блоку — куцой textbox
Cacoo
Giffy
LovelyCharts

но к сожалению у них либо вообще нет поля описания для блока, либо маленький блочек PlainTex в поле Properties

Answer 3

[Александр]

мы использовали doxygen — позволяет генерить по коду диаграммы классов
По БД — не знаю. Используем комментарии к полям и таблицам,
reingeneering БД в диаграмму (логическими частями) любой визуальный инструмент: MySQLWorkbench (не оч удобен), DBDesigner4 www.fabforce.net/downloads/

Comments

[Александр]

у меня была идея написать SQLDocumentator который строил документацию по дампу
но идея так и осталась на бумаге

[Всеволод]

ИМХО MySQLWorkbench последнее время все же лучше DBDesigner4.