Какие есть бесплатные системы ведения документации?
Хочу занятся проработкой требований, архитектуры и первичной спецификации API своего проекта. Хочу найти инструмент, где я смогу удобно систематизировать свои мысли. Сам я неоднократно занимался подобными задачами на работе, но инструменты были навязаны работадателем: у меня есть опыт работы c платным Confluence и бесплатным MKdocs. Работать с MKdocs мне понравилось больше, мне легче писать маркдаун, чем накликивать документацию мышкой в барузере, также мне нравится, что такую документацию можно держать под версионным контролем в своем гит-репозитории. Однако я не уверен, что это лучший инструмент.
Подскажите, пожалуйста, инструменты для ведения документации.
Мне кажется у Вас 1 вопрос и 2 требования: "бесплатные системы ведения документации" и "где я смогу удобно систематизировать свои мысли". Вопрос как Вам удобно систематизировать свои мысли? Просто быстро записав текст? Или может доски (Trello)?
Я рекомендую Sphinx (+doxygen) для доков и Trello для управления проектов!
Требования действительно два:
1 Бесплатный инструмент;
2 Простота редактирования - это очень субъективный пункт. Мне например легко редактировать
Markdown. Конечно мне бы хотелось, что-то типа того же `Confluence` когда можно все мышкой сделать, но у меня был негативный опыт связанный с ним. Инструмент возможно хороший, но слишком большой и сложноый. В проекте, где я с ним работал, часто оказывалось, что какой-то функционал отключен. Это выяснялось, когда в команду приходил новый человек с более правильным опытом и ему чего-то не хватало, тогда писалась заявка и "человек с доступом" расширял функционал Confluence. А если ты не знаешь, что там что-то есть нужное тебе, то и заявк не напишешь. Надеюсь я ясно описал свое недовольство.
В готовом виде документация скорее всего будет состоять из двух типов страниц:
1 Текстовая информация о проекте, в том числе список требований.
2 Описание API (и его версий), т.е. запросов, ответов, ошибок и прочего.
Оба варианта будут включать картинки, оба варианта будут ключать ссылки на другие части документации.
Часть документации из п. 1 я уже написал используя гуглдокс, но мне не очень нравится пользоваться этим инструментом и я не хочу документацию в разных местах.
Trello мне знаком, но это, как вы и сказали, для управления проектом. Сейчас же я хочу описать концепцию. Проекта фактически нет.
Спасибо за паш совет, я обязательно посмотрю Sphinx (+doxygen).
Простой
