lybin
@lybin
looking for remote full time job python backend

Система документирования для разрабатываемого проекта

Доброго времени суток!
Разрабатываем веб-проект, проект развивается и расширяется, потребовалась система документирования для разработчиков, чтобы не держать все в голове, потому что это становится сложно.
Что бы вы нам посоветовали для решения этой задачи?
Заранее всем благодарен за предложения. Спасибо!

P.S. не обязательно сторонний сервис, даже лучше нет, потому что проект коммерческий.
Используем linux и mercurial.

P.S.S. Нужна простая, но удобная документация. Описывать весь проект нам нет необходимости, тем более потом поддерживать огромную документацию в актуальном состоянии это дополнительные время-затраты. Надо, например, пометить что дописываем такой то класс к input будет то-то, такой то то-то, может какие то ньюансы постепенно выносить, например, у кого то из разработчиков появится вопрос, ответ на который явно не виден в коде — сразу в базу знаний, предполагая что такой может появиться еще у кого то, описать конфиги плагинов и т.п., чтобы вновь прибывшим программистам говорить фразу что-то вроде: «Учись гуглить!», ссылаясь на нашу базу знаний:)
  • Вопрос задан
  • 6053 просмотра
Пригласить эксперта
Ответы на вопрос 9
opium
@opium
Просто люблю качественно работать
Возьмите оригинал в виде медиавики.
Ответ написан
mambet
@mambet
Медиавики тяжеловат… Проект очень большой? Вы точно уверены, что нужна отдельная система для документирования? Можно ведь использовать встроенные wiki во всякие разные багтрекеры/PM-системы…
Ответ написан
AntonMinsk
@AntonMinsk
Есть не плохая трекинговая система Trac ее можно использовать как wiki так и как трекер тасков.
Ответ написан
nc00x
@nc00x
Я использую сфинкс для таких целей. Да и вообще как систему хранения знаний. Можно экспортировать в латех, что иногда бывает удобно.
Ответ написан
Neutron
@Neutron
Поддержу предыдущего комментатора.
Добавлю лишь урл на скачку медиавики — http://www.mediawiki.org/wiki/Download
Ответ написан
AlexZaharow
@AlexZaharow
Программист.
Самый трудный шаг, после того, как заставишь себя вести логи — это читать их каждый день и за прошлый день, и за неделю назад. ;)
Ответ написан
@1nd1go
google docs? если не надо кроссылки внутри статей, то очень неплохо, ИМХО
Ответ написан
Для разработчиков (описание интерфейсов) вполне нормально можно использовать %используемый_ЯП%doc и/или тесты. Главное следить за актуальностью, но это для любой документации проблема, но проще документировать прямов коде или тестах (при использовании TDD), чем леззь куда-то.
Ответ написан
Ваш ответ на вопрос

Войдите, чтобы написать ответ

Войти через центр авторизации
Похожие вопросы