Доброе утро! мне тоже не приходит тестовое, в спаме тоже пусто(

Сейчас напишу вам

я вот с GitBook сейчас работаю, составляю внутреннюю базу знаний тоже) по функциям немного уступает Conf (или я пока не перестроилась до конца), но в целом удобный инструмент. Чем-то похож на Notion тоже

Добрый день!
Я претендую на должность технического писателя в компании Improvado. Я уже прошла 1 этап собеседования и мне прислали тестовое задание. Нужно предложить систему ведения документации по абстрактному, похожему на Improvado проекту (B2B Saas платформа для агрегирования маркетинговых данных). Описать критерии по которым выбрана лучшая система.
Нашла и прочитала много статей, но ориентироваться на противоречивые мнения авторов сложно.

Подскажите, пожалуйста, был ли у вас опыт использования подобных систем? Какие критерии и решения вы бы могли посоветовать?

Начнём с уточнений. Какая документация? для кого? как часто она обновляется?

среди критериев - чтобы коллеги легко могли ориентироваться как в перечне документов (их версиях), так и в самих документах
а под системой ведения документации подразумевается прям система-система - АС...или связанный набор правил, организация процесса ведения ?

раз б2б и документация внутренняя, то важно понимать, какие роли на проекте у вас есть; какую информацию компания готова раскрывать и документировать

Думаю, что система - не набор правил, так как нужно выбрать лучшую (наиболее подходящую) из существующих

на сайте их документацию нашла только в разделе Саппорт - не густо там...еще б английский знать хорошо %)

из критериев - будут ли документацию писать только техписатели или должна быть возможность у остальных сотрудников что-то добавить или исправить. У нас, например, платформа установлена только у техписов, у остальных доступ только на чтение готового скомпилированного документа. И если разработчик хочет что-то добавить или исправить, он ставит задачу техпису. Это и хорошо (единый стиль, вычитка), и плохо (разработчик лишний раз не будет заморачиваться и ставить задачу на доработку. А так бы быстро сам поправил что надо). Критерий наверное для админской документации, не для пользовательской.

+++

День добрый! А кто-то пишет в VS Code на Markdown и  RST? Какие плагины используете для проверки синтаксиса, сборки в формате docx и  html? И может вообще где-то можно почитать, как настроить VSC для технического писателя?

у @Lananovikova был вебинар https://gitlab.com/svetlnovikova/webinar/-/blob/master/post-webinar-materials.md

Огромное спасибо!!!! То что нужно!!!

@qwertyum00, добрый день! Подскажите пожалуйста, отправляла вчера заявку на участие в обучении, тестовое задание до сих пор не пришло

Напишу вам в личные сообщения

https://code.visualstudio.com/docs/languages/markdown

Всё зависит от того, что вам надо.

When it's bad, it's often worse than nothing.

А большинство живут с такой, что лучше б ее вообще не было, чем такая — один стыд и расстройство.