Size: a a a

DocOps-сообщество

2021 May 06

VW

Vinni Winterlight in DocOps-сообщество
Типа того. Я технический писатель, дайте мне всё готовое. И уж я то напишу-у-у.  А сбор информации это не для меня. D:
источник

V

Vitaly in DocOps-сообщество
товарищи, пардон, продолжу дискуссию через несколько часов, вынужден отлучиться
источник

ME

Maria Ermakovich in DocOps-сообщество
а я разработчик, мне не платят за написание документации ))
источник
2021 May 07

J

Jonny Cuba in DocOps-сообщество
Коллеги, а кто-нибудь проводил исследование какие разделы и где можно переиспользовать при едином источнике,  может уже есть такое решение или семинар по этому? Сейчас рисую такую схему, но там только человек-паук и я разберемся)
источник

AY

Andrei Yemelianov in DocOps-сообщество
я сейчас провожу
источник

J

Jonny Cuba in DocOps-сообщество
Андрей, а как вы структурируете документацию? Я сейчас разбил примерно следующим образом: доки разработчиков с примерной структурой топиков (техпроект), API, тест-кейсы и от них связи к финишным документам (ГОСТ, сайт). Плюс добавил связь от участников команды, кто-какие доки разрабатывает.
источник

AY

Andrei Yemelianov in DocOps-сообщество
Руководства пользователя/администратора, API, небольшая и отдельная группа - ГОСТ
источник

J

Jonny Cuba in DocOps-сообщество
вы получается  от документации пошли, а я от техпроекта, какая дока уже формируется в проекте, какую нужно добавить в проект, чтобы участникам команды было легче и нагляднее разрабатывать и потом в какие доки это можно вставить и переиспользовать.
источник

AY

Andrei Yemelianov in DocOps-сообщество
сейчас занят по работе, отвечу позже
можем вечером обсудить
источник

J

Jonny Cuba in DocOps-сообщество
хорошо
источник

IR

Irina Rybnikova in DocOps-сообщество
Приветствую. Мы достаточно сильно переиспользуем тексты в документации. Начиная с общих разделов (обращение в поддержку, о компании, о документе, условные обозначения и многие другие), так и в принципе любой кусок текста (например, шаги инструкций).
У нас, например, активно тексты из пользовательской документации пошли в сейловые документы, в материалы обучения и другие смежные документы.
Мы в целом поддерживаем культуру переиспользования в департаменте и отслеживаем эту тему )

Отвечая на вопрос - переиспользовать можно что угодно, если это полезно в вашем случае ) Хотя мне кажется это почти всегда полезно.
источник

J

Jonny Cuba in DocOps-сообщество
Ирина, спасибо!  Вот я и пытаюсь понять что можно переиспользовать. Сейчас нашел хорошее решение использовать тест-кейсы тестировщиков в ПМИ и думаю можно как-то их и в РП использовать.
источник

IR

Irina Rybnikova in DocOps-сообщество
Возможно, в вашем случае это вариант. В моем опыте тест-кейсы не получалось использовать as is, приходилось бы переписывать тексты. Это скорее к вопросу лингвистического качества текстов.
источник

J

Jonny Cuba in DocOps-сообщество
источник

J

Jonny Cuba in DocOps-сообщество
источник

J

Jonny Cuba in DocOps-сообщество
Что-то такое получается)) но общая картина получается
источник

rK

rJIynbIu` KOT in DocOps-сообщество
не ожидал увидеть фотографию монитора в наше время, да и ещё в таком чате...
источник

ME

Maria Ermakovich in DocOps-сообщество
это чтобы обойти NDA :D
источник

AK

Aleksandr Kosolapov in DocOps-сообщество
DLP может ?)
источник
2021 May 09

NP

Nikolaj Potashnikov in DocOps-сообщество
Коллеги, получилось создать первое (даже второе) приближение нативного конвертера Asciidoctor в Open Document https://github.com/CourseOrchestra/asciidoctor-open-document. Если у кого есть интерес + желание посмотреть/потестировать, заранее благодарен. Issues are welcome.  Use cases are still more welcome. Пока PRs are not welcome. Донастрою проект позднее и сообщу
источник