поняла, буду реализовывать
Спасибо!

Мне кажется это не тот чат 🤔

Не то окно)

да))) точно

#wanted_tw

Company: Pleeco
Location: Saint-Petersburg // remote
Contact: @ooonastia

About Us

Pleeco is an engineering company on a mission to empower people to achieve more by using data and technology. We create innovative solutions that enable people to understand data and make their ideas actionable.

Pleeco Kelp is a no-code visual development platform where teams can collaborate to rapidly design, build, and share operational data-driven applications. By quickly stitching together data, APIs, and interface components into useful operational tools, people can do more and better work. We’ve done a lot with a little, but there’s much more work to be done. And we'd like your help.

Role

We are looking for a Technical Writer to produce high-quality documentation that contributes to the overall success of our products. You will join a team of talented engineers, designers and product managers who collaborate to make our products easier to use.

Responsibilities

- Work with internal teams to obtain an in-depth understanding of the product and the documentation requirements
- Produce high-quality documentation that meets applicable standards and is appropriate for its intended audience
- Write easy-to-understand user interface text, code annotations, online help and developer guides
- Create tutorials to help end-users use Kelp and a variety of sample applications build in Kelp
- Analyze existing and potential content, focusing on reuse and single-sourcing opportunities
- Create and maintain the information architecture

Requirements

- Proven working experience in technical writing of software documentation
- Ability to deliver high quality documentation paying attention to detail
- Ability to quickly grasp complex technical concepts and make them easily understandable in text and pictures
- Excellent written skills in English
- Strong working knowledge of Markdown and document publishing systems
- Basic familiarity with the SDLC and software development
- University degree in Computer Science, Engineering or equivalent preferred

Привет всем!

Может, у кого-то был похожий опыт, поделитесь, пожалуйста, советом.

В новой компании только определяемся с процессами ведения документации.
Сейчас стоит задача подобрать ПО для реализации пользовательской документации на программный продукт.

Требования:

— Одновременное существование документации для разных версий продукта, возможность переключаться между ними. Нужно для саппорта и пользователей.

— Удобство при работе с переводами (сейчас 2 языка, в будущем будет много).

— Возможность встроить тексты хелпа на сайт компании или генерирование статического сайта, на который с основного будет реализован переход. Если генерирование отдельного сайта, то должна быть возможность кастомизации дизайна.

— Интеграция с Git тоже было бы неплохо.


Сейчас уже есть Confluence. Предлагали ещё рассмотреть Gitbook.

Про Gitbook не нашла про возможность переключения между документацией для разных версий продукта.

Пока вычитала про плагины для Confluence, раз он у нас уже есть: Scroll versions, Scroll Viewport, Scroll Translations. В принципе это покроет наши потребности для первых 3-х пунктов.
С Git тоже есть интеграция, но не очень вижу его нужность в этой связке, если всё через сам Confluence реализуется.

Может, есть вариант, сразу идти от хранения документации в репозитории. Вести разные ветки для разных версий продукта, и чтобы изменения в этих ветках подтягивались на сайт сразу (нужная ветка к нужной версии продукта), где можно выбрать, для какой версии продукта хотим посмотреть документацию.

Раньше работала в крупной компании с технологией Dita, где сборку на сервере и пакетов на выкладку настраивали разработчики.
Сейчас я единственный технический писатель, пока непонятно, на какую помощь разработчиков могу рассчитывать, поэтому ищу наиболее доступную и понятную реализацию. Но хочется сделать сразу хорошо и автоматизированно.

Посмотрите Antora. Там очень хорошо организована работа с версиями.

Спасибо большое! Посмотрю.

Schema ST4 - но она недешева

> Может, есть вариант, сразу идти от хранения документации в репозитории. Вести разные ветки для разных версий продукта,

есть, и это отличный вариант :)

На этой (https://www.tarantool.io/en/doc/latest) и прошлой (docs.plesk.com) работе использовал Sphinx, он решает все ваши задачи.

Спасибо всем за советы! Буду изучать!

Николай, а вы на русском доку пишете?

Пишем на английском, переводчики переводят на русский. А в Plesk тоже пишут на английском, а потом переводят на 10 языков.

Тогда наверное что-то сломалось(

Tarantool Data Grid 1.6 — исключение, для него доки только на русском. Для версии 2.0 сразу пишем на английском, доки пока что в закрытой бете.

Понятно. Ну я не критики ради. Просто решил не проходить мимо)

Мы используем MadCap Flare. Там большинство указанных вопросов решается. У MadCap также есть решения для локализации и совместной работы. К сожалению, они подняли цены на продукты.

Я крайне рекомендую Antora+adoc.
Крайне мощный кастомизированный сет

Переводы завезли уже в Антору?

Ник, если честно, переводы для меня имеет низкий приоритет )