Как построить документирование на базе Sphinx, ReST, Git, LaTeX и PHPРабочие ситуации и задачи
Основатель и разработчик CMF, на базе которого строятся все web-проекты компании. Идейный автор и разработчик портала документации компании.
6 лет в web-разработке. Люблю программировать, проектировать и анализ. Обучаю молодых коллег.
Sphinx Docs собирает документацию из файлов в формате reStructuredText. Многие разработчики используют его в своих проектах. Но как быть, если нужен инструмент документирования для всей компании - руководителей, маркетологов, разработчиков, офис-менеджера и т.д.?
Расскажу, как мы решили это для себя, используя нехитрые технологии - Sphinx, ReST, Git, LaTeX и PHP, запилив на их базе редактора документации "для всех", который активно используется уже более года.
Из доклада вы узнаете, как мы выбирали техническую базу, пройдя через Wiki и Google Docs. Какие грабли можно поймать при реализации и внедрении и как их обойти. Отдельно остановлюсь на генерации в форматах LaTeX и PDF, на организации git в документации.