Подумать, где и как можно вести документацию. Нужно учесть следующее:
[ ] Мы работаем в формате стартапа, поэтому что-то сложное нам не нужно
[ ] У нас ограничения по интеграции с гитхаб, так что какие-то решения нам могут не подойти
[ ] Мы будем записывать туда информацию как по текущим имплементациям, так и по идеям на будущее
[ ] Важна поддержка версионирования
[ ] В приоритете варианты, поддерживающие интеграцию с plantUML или drawIO
Есть некоторые предпосылки. Confluence мощный инструмент, но обладающий своими большими минусами, поэтому его использование в самом крайней случае. Самый оптимальный вариант, как кажется, это ведение доки в гите, потому что здесь мощная поддержка версионирования, очевидно. В некоторых сервисах есть документация, построенная на языке разметки markdown, но он крайне урезанный и не самый удобный, может есть что-то получше. Можно изучить, что такое github wiki и будут ли проблемы с переносом доки из github wiki, если проект будет уходить в другую организацию внутри гитхаба или вовсе в гитлаб или гитбакет.
Подумать, где и как можно вести документацию. Нужно учесть следующее:
Есть некоторые предпосылки. Confluence мощный инструмент, но обладающий своими большими минусами, поэтому его использование в самом крайней случае. Самый оптимальный вариант, как кажется, это ведение доки в гите, потому что здесь мощная поддержка версионирования, очевидно. В некоторых сервисах есть документация, построенная на языке разметки markdown, но он крайне урезанный и не самый удобный, может есть что-то получше. Можно изучить, что такое github wiki и будут ли проблемы с переносом доки из github wiki, если проект будет уходить в другую организацию внутри гитхаба или вовсе в гитлаб или гитбакет.