Ну что, товарищи айтишники. Пришло время доказать, что вы айтишники, а не куча похапешников и одменов из церковно-приходской школы. Вопрос есть, прямо айтишный. И даже не про биткоины.
Требуется внедрить для проекта документацию. Документация для конечного пользователя, обычная, текстом. Что-то меня этот вопрос всю жизнь стороной обходил, обходился онбордингом с динамическими подсказками и прочей современной требухой. Но тут требуется именно текстовая документация.
Вопрос: где и как вести.
Требования:
1) Документацию будут писать люди от разработки далёкие, им нужен WISYWIG редактор, с красотой и кнопочками как в ворде. А не эти ваши git force push. Версионирование документации пригодится, а вот различные ветки - вряд ли.
2) Документация на четырех языках, около 50 страниц и 1000 картинок
3) Сам исходник документации должен быть во вменяемом общепризнанном markdown формате, чтобы можно было его просто разместить в основном проекте на отдельной странице. Либо документация должна поставляться как отдельное веб-приложение или страница, просто вставим ссылку из основного приложения, или положим в iframe (кек).
4) Сервисы для стороннего хостинга документации не предлагать - документация должна быть закрытой с приватным URL и доступна в том числе с ограничениями на выход в сеть.
5) Документация должна быть внедрена в основное приложение, сторонние WIKI системы тут не очень подходят. Хотя с удовольствием послушаю про удачный опыт внедрения.
Как временный вариант сегодня утром создал новый репозиторий, натолкал туда .md файлов, и в основном приложении во время сборки подтягиваю всё это добро в папку, собираю в основное приложение на отдельную страничку-роут и поставляю вместе с приложением. Внешние ресурсы типа картинок валяются локально или вечными ссылками на Amazon S3. Минус тут в том, что составители документации будут вынуждены форкать репу, разбираться с гитом и вот это вот всё. А у них лапки. Можно конечно прямо в UI гитхаба (да, у нас гитхаб) делать, но там редактор туповат, кнопочек нет, нужно прямо текстом писать, ссылки вставлять, и предпросмотр неудобный.
Попробовал еще
https://hackmd.io/ , но там интеграция с гитхабом тоже сложновата - народ начинает тупить, творить дичь, перезаписывать чужие изменения, не понимает как создать новый файл.