Size: a a a

technicalwriters

2020 September 01

ME

Maria Ermakovich in technicalwriters
такой компромисс, чтобы писатели не лезли в код
источник

KC

Kseniya Chudakova in technicalwriters
Maria Ermakovich
какие-то доки автоматизированны через документационные модули, например если ты девелопер и добавляешь или удаляешь фичи (DSL, архетипы), то твоя ответственность - обновить include в документационном модуле, из которого в конце спринта генерятся списки фич
Foliant используете для инклудов?
источник

KC

Kseniya Chudakova in technicalwriters
Maria Ermakovich
какие-то доки автоматизированны через документационные модули, например если ты девелопер и добавляешь или удаляешь фичи (DSL, архетипы), то твоя ответственность - обновить include в документационном модуле, из которого в конце спринта генерятся списки фич
плюсую за распредление ответственности
источник

ME

Maria Ermakovich in technicalwriters
Kseniya Chudakova
Foliant используете для инклудов?
бгагага. нет, увы. Maven modules (речь про код же)
источник

ME

Maria Ermakovich in technicalwriters
потом из джава кода генерим html с помощью reflection и заливаем на конфлюенс через rest api
источник

KC

Kseniya Chudakova in technicalwriters
Maria Ermakovich
бгагага. нет, увы. Maven modules (речь про код же)
это я начала overthinking 😐 подумала, что можно в промежуточную ступень сначала изменения подливать
источник

KC

Kseniya Chudakova in technicalwriters
Maria Ermakovich
потом из джава кода генерим html с помощью reflection и заливаем на конфлюенс через rest api
ок, спасибо)
источник

KC

Kseniya Chudakova in technicalwriters
Daria
Привет всем.
У нас есть двуязычная пользовательская документация по сложному продукту. Есть регулярные (примерно раз в две недели) обновления в продукте.
Мы хотим каким-нибудь образом отслеживать все статьи документации, которые требуется обновлять.
Бывает так, что в статье, в которой не ждёшь, обнаруживается устаревший скриншот или какая-то ещё информация.
Наверняка кто-то сталкивался? Как решили?

docs-as-code, md
Наверное, тут ещё можно добавить: что делать, если большое количество документации было написано до тебя? Прочтение и ознакомление, конечно же было. И как предотвратить в будущем такую ситуацию (комметарии в коде и тикеты 👍)?
источник

AD

Alyona Devon in technicalwriters
Kseniya Chudakova
А как у вас происходит онбординг новых техписателей?
что ж) тогда опыт не поможет, максимальный "код" в который влажу - это html верстка страницы для создания контента
все статьи, включая апи документация это все в джумле, обычные страницы. вот только недавно пару разделов на свагере добавляла

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

TS

Timur Snytkin in technicalwriters
Коллеги, подскажите пожалуйста. По ТЗ у нас создаётся одно изделие, но в нескольких исполнениях (ПЭВМ, моноблок, планшет). Как в таком случае делается документация. Один комплект на изделие со всеми исполнениями, или комплект документации на каждое исполнение?
источник

L

Luiza in technicalwriters
Timur Snytkin
Коллеги, подскажите пожалуйста. По ТЗ у нас создаётся одно изделие, но в нескольких исполнениях (ПЭВМ, моноблок, планшет). Как в таком случае делается документация. Один комплект на изделие со всеми исполнениями, или комплект документации на каждое исполнение?
Здравствуйте, один, под варианты исп. разные внутри комплекта можно выпустить отдельные документы при необходимости, если комплекты разные то и изделия разные
источник

IA

Ivan Abashkin in technicalwriters
Timur Snytkin
Коллеги, подскажите пожалуйста. По ТЗ у нас создаётся одно изделие, но в нескольких исполнениях (ПЭВМ, моноблок, планшет). Как в таком случае делается документация. Один комплект на изделие со всеми исполнениями, или комплект документации на каждое исполнение?
У нас один док на несколько моделей, у которых внешний вид одинаковый. Если внешний вид отличается - новый док на такую модель.
источник

IA

Ivan Abashkin in technicalwriters
Timur Snytkin
Коллеги, подскажите пожалуйста. По ТЗ у нас создаётся одно изделие, но в нескольких исполнениях (ПЭВМ, моноблок, планшет). Как в таком случае делается документация. Один комплект на изделие со всеми исполнениями, или комплект документации на каждое исполнение?
Если у вас в будущем не планируется отдельное развитие каждой модификации, то я бы запихал в один док.
Если модификации будут развиваться самостоятельно, то в разные доки.
источник

TS

Timur Snytkin in technicalwriters
Спасибо
источник

TS

Timur Snytkin in technicalwriters
Вопрос немного сложнее -- два варианта исполнения в каждом из них три типа изделия (ПЭВМ, ноутбук, моноблок). А варианты исполнения отличаются обрабатываемой информацией
источник

Х

Хома in technicalwriters
Одно изделие (один комплект доки), внутри которого два варианта исполнения:
1. Один тип данных (ХХХ-01), доступные варианты "корпусов":  ПЭВМ, ноутбук, моноблок;
2. Второй тип данных (ХХХ-02), доступные варианты "корпусов":  ПЭВМ, ноутбук, моноблок.
источник

TS

Timur Snytkin in technicalwriters
Получается два комплекта документов. По одному на каждый вариант исполнения?
источник

Х

Хома in technicalwriters
Так, давайте с самого начала) По стандартам ЕСКД или нет жесткого требования?
источник

Х

Хома in technicalwriters
Если по ЕКСД и по ТЗ одно изделие, то у вас на изделие один децимальный номер. А варианты исполнения обозначаются через -ХХ (ГОСТ.2.201). И по факту по ЕСКД у вас будет именно один комплект, внутри которого будут "подгруппы" на каждый вариант исполнения (по факту у вас их 6)
Есть вариант сделать 2 исполнения в зависимости и сделать именно варианты "корпусов":  ПЭВМ, ноутбук, моноблок (но это очень спорный вариант, зависит от видения заказчика и нормоконтролера)
Если у вас именно прописано, что 2 изделия, обрабатывающие разную информацию, с вариантами исполнения, то тогда получается 2 комплекта доки (на каждую информационную группу), но внутри каждого комплекта все равно будут варианты исполнения  01-03:  ПЭВМ, ноутбук, моноблок. И опять же, для данного случая можно написать не варианты исполнения, а "типы корпусов")
источник

ОS

Олег SoftFAN in technicalwriters
Foam
https://github.com/foambubble/foam
VS Code расширения для менеджмента знаний, вдохновлённое Roam Research.
источник