Привет. Я Анна, руководитель маркетинговой компании АБ. Может кто-нибудь помочь настроить ip телефонию битрикса?

Ну что, товарищи айтишники. Пришло время доказать, что вы айтишники, а не куча похапешников и одменов из церковно-приходской школы. Вопрос есть, прямо айтишный. И даже не про биткоины.

Требуется внедрить для проекта документацию. Документация для конечного пользователя, обычная, текстом. Что-то меня этот вопрос всю жизнь стороной обходил, обходился онбордингом с динамическими подсказками и прочей современной требухой. Но тут требуется именно текстовая документация.

Вопрос: где и как вести.

Требования:

1) Документацию будут писать люди от разработки далёкие, им нужен WISYWIG редактор, с красотой и кнопочками как в ворде. А не эти ваши git force push. Версионирование документации пригодится, а вот различные ветки - вряд ли.
2) Документация на четырех языках, около 50 страниц и 1000 картинок
3) Сам исходник документации должен быть во вменяемом общепризнанном markdown формате, чтобы можно было его просто разместить в основном проекте на отдельной странице. Либо документация должна поставляться как отдельное веб-приложение или страница, просто вставим ссылку из основного приложения, или положим в iframe (кек).
4) Сервисы для стороннего хостинга документации не предлагать - документация должна быть закрытой с приватным URL и доступна в том числе с ограничениями на выход в сеть.
5) Документация должна быть внедрена в основное приложение, сторонние WIKI системы тут не очень подходят. Хотя с удовольствием послушаю про удачный опыт внедрения.

Как временный вариант сегодня утром создал новый репозиторий, натолкал туда .md файлов, и в основном приложении во время сборки подтягиваю всё это добро в папку, собираю в основное приложение на отдельную страничку-роут и поставляю вместе с приложением. Внешние ресурсы типа картинок валяются локально или вечными ссылками на Amazon S3. Минус тут в том, что составители документации будут вынуждены форкать репу, разбираться с гитом и вот это вот всё. А у них лапки. Можно конечно прямо в UI гитхаба (да, у нас гитхаб) делать, но там редактор туповат, кнопочек нет, нужно прямо текстом писать, ссылки вставлять, и предпросмотр неудобный.

Попробовал еще https://hackmd.io/ , но там интеграция с гитхабом тоже сложновата - народ начинает тупить, творить дичь, перезаписывать чужие изменения, не понимает как создать новый файл.

Прочитал текст, вздохнул и включил новый видос из курса "Php для начинающих"

Прошу прощения если задел чьи-то похапешные чувства =)

Тут ещё хуже) синдром Не знаю, что сказать, но сказать очень хотелось)

мы юзаем wiki от атласиана - конфлюенс

Мы тоже. Но именно эта дока должна поставляться вместе с приложением.

@TimDron профессионально именно этим занимается на сколько знаю

Или можно в https://stranzit.ru/ спросить, они много чем занимаются.

Мои олдскулы давно хотели бы сделать что-то подобное, но с связке LyX + VCS + TeX|LaTeX со сборкой этого всего в pdf или в любой другой формат. Но меня обычно никто не понимает. Да и наверно затратно такое внедрить для обычных пользователей.

а чем конфля не устраивает стенд элон???

VCS - читай Git

у нее поддержка заканчивается скоро но и пофиг

там и версионирование и интеграция со всем и гит можно для кода внутри использовать

ну т.е. все что в требованиях и даже более

Документация должна поставляться вместе с приложением. И в будущем иметь более глубокое внедрение, в т.ч. в виде подсказок всяких, микроссылочек и т.п.

LyX. А я думал это я старый))

эх вот тз все-таки никто не умеет писать :(

Но вообще идея с локальным редактором тоже имеет место быть. Один раз настроить какой-нибудь редактор (типа VS кода с плагином для MD или типа того), настроить гит, показать как пушить и коммитить. Но это чревато ошибками.