Size: a a a

technicalwriters

2021 March 17

OI

Olga Ilchukova in technicalwriters
Oleg M
Кто же в чате:
Анонимный опрос
41%
Я тех пис
2%
Я писатель, но не технический
2%
Я поэт
14%
Я аналитик и техпис
5%
Я программист и техпис
2%
Я dev ops и техпис
2%
Я рекрутер
6%
...меня насильно заставляют писать
17%
Я котик
9%
Я только читаю что тут пишут
Проголосовало: 312
и варианта бывших техписов тоже нет :)
источник

OM

Oleg M in technicalwriters
Alyona Devon
тут нет варианта техпис, ux райтер и локализатор 😁😁
и техпис техпису рознь
на самом деле это была шутка....
показательным будет другой опрос. точнее несколько. с одним выбором.
источник

D

Daria in technicalwriters
Olga Ilchukova
и варианта бывших техписов тоже нет :)
Бывших техписов не бывает
источник

EI

Elena Ivanova in technicalwriters
Olga Ilchukova
и варианта бывших техписов тоже нет :)
++
источник

OI

Olga Ilchukova in technicalwriters
Daria
Бывших техписов не бывает
и то верно :)
источник

OM

Oleg M in technicalwriters
логика в чем наверно должна быть...

а) выявить именно техписов - рекрутеров - прохожих ... ну и котиков...

б) выявить категории техписов....  кто там техпис такой или эдакий...

тогда думаю будет показательно
источник

ВЩ

Владимир Щепин... in technicalwriters
Daria
Бывших техписов не бывает
Кольт всех уравняет
источник

OI

Olga Ilchukova in technicalwriters
Oleg M
логика в чем наверно должна быть...

а) выявить именно техписов - рекрутеров - прохожих ... ну и котиков...

б) выявить категории техписов....  кто там техпис такой или эдакий...

тогда думаю будет показательно
добавьте тогда QA и техпис, а то эта роль пропущена, а я как раз там
источник

AB

Albina Brycheva in technicalwriters
Nick Volynkin
Берите Sphinx ;)
Эта программа умеет хранить исходники, чтобы в случае обновления скриншота, можно было обновить картинку, не рисуя заново выделения, указатели ?
источник

OM

Oleg M in technicalwriters
Olga Ilchukova
добавьте тогда QA и техпис, а то эта роль пропущена, а я как раз там
👍🏻 я уже думал сам об этом но уже когда отправил опрос
источник

OI

Olga Ilchukova in technicalwriters
ну или придется за котика голосовать, ничего не поделать :)
источник

SR

Stas Rychkov in technicalwriters
Albina Brycheva
До этого рисунки готовили в Xara, Adobe Illustrator и в принципе достаточно удобными они мне казались. Но для Вики  громоздкие что ли они
А почему от AI решили отказаться? Если привыкли работать, вряд ли что-то заменит его.
источник

NV

Nick Volynkin in technicalwriters
Albina Brycheva
Эта программа умеет хранить исходники, чтобы в случае обновления скриншота, можно было обновить картинку, не рисуя заново выделения, указатели ?
Вот это интересно. Вы хотите хранить картинку и выделение как два слоя? Мне кажется, это функциональность графических редакторов вроде Фотошопа
источник

NV

Nick Volynkin in technicalwriters
Александр Парень
Переслано от Ivan Abashkin
Вскоре всплыл ещё один момент - необходимо было отказаться от Evernote. Это был прекрасный инструмент. В нём было легко искать информацию и легко её создавать.
Но дело в том, что политика компании запрещала привязываться к облачным сервисам (в целях безопасности и для того, чтобы не зависеть от работоспособности сторонней инфраструктуры).
Работа с Evernote у нас была по собственной инициативе и как-бы из под полы. Неофициально.
А для Knowledge Centered Support мне необходимо было создать официальные регламенты, которые необходимо было бы соблюдать всем сотрудникам.

На замену Evernote я рассматривал всяческие Wiki-движки, корпоративные порталы по накоплению знаний. Сервисы документирования:
После отсева остались вот такие варианты:
- Atlassian Confluence
- Xwiki
- Bookstack
- И вариант, который выиграл.

Atlassian Confluence
Это был топ жир. Система специально предназначенная, чтобы большие компании вели там свою документацию. Отточенная, отлаженная, с большим сообществом. Дорогая. Связывающая руки.
В тот момент мы не могли себе позволить потратить такие деньги, которые требовались за 20-50 лицензий на Конфлюенс.

Xwiki
Корпоративная Open-Source замена Конфлюенсу.
Тяжелая, глючная, сложная. Бесплатная.
Мы в неё копнули, но вынуждены были остановится из-за непреодолимых приступов тошноты.

Bookstack
Прекрасный Open-Source аналог и Confluence и XWiki. Красивая, простая, удобная система с контролем доступа. Там даже можно нативно подключить draw.io для рисования блоксхем и совместного их редактирования.
Погоняли её, но не взлетела.
Два нюанса:
- По какой-то причине движок разметки ломал оглавление на длинных документах
- На тот момент было всего два уровня вложенности каталогов и народ не понимал как распихать текущие проекты на такую бедную структуру.

Вариант который выиграл
Это текстовые файлики. Вернулись обратно к истокам.
В тот момент у нас развернули корпоративный портал - Bitrix24. Там можно было создавать аналог яндекс.диска, но по проектам.
Мы делали общий шаренный диск, куда складывали файлы в удобном нам формате.
Там же можно было отследить историю изменений.
Битрикс это не только корпоративный портал, но и система управления задачами. Поэтому жизненный цикл статьи мы выстараивали через задачи.
Правда тут речь уже не шла о "выращивании" статей из зародышей. Тут уже были запросы "сверху" на написание той или иной статьи исходя из потребностей.
Поиск по базе файликов выполнялся с помощью DocFetcher.

Но Битрикс система глючная. То и дело у кого-то случался конфликт синхронизаций. Процесс работы со статьями вызывал споры из-за разных форматов. Написание статей по запросам попахивало бюрократией и не позволяло статьям появляться органичным образом.
База со статьями разросталась и вместе с ней рос её размер. Это создавало проблемы на компьютерах с заканчивающимся жестким диском.
DocFetcher был костылём, который люди тяжело воспринимали.
Ну и весь этот подход не очень пересекался с идеей KCS.

А я размышлял. Людям явно зашла работа с простыми файликами. И тут мы в отдел разработки установили GitLab.
Вот  оно!
Репозиторий со статьями в Markdown-формате. Гит как контроль версий. Поиск по всем репозиториям!  Ишью! Теги!

Сейчас мы перевели всю базу внутренних и внешних статей в Git-репозитории.
Новые статьи пишем сразу туда. Чуть позже накатим на них какой-нибудь генератор статических сайтов и откажемся от стороннего сервиса UserEcho в качестве хостинга статей для клиентов.

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

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

AB

Albina Brycheva in technicalwriters
Nick Volynkin
А почему выбрали ДокуВики? Какие ещё варианты рассматривали?
Хранение в виде текстовых файлов, наличие плагинов, простота, бесплатно.

Рассматривали Confluence еще, но это скорее я и программисты предлагали. До этого программисты для внутренних доков пробовали MediaWiki, но не особо успешно - один вел, другие ругались, что неудобно. Я краем глаза поглядела, тоже не зашла.
Вот собственно эти три системы.
Ну и руководителей смущает сильно БД, что в Confluence, что в XWiki.
источник

VK

Vladimir Kozlov in technicalwriters
Nick Volynkin
Вот это интересно. Вы хотите хранить картинку и выделение как два слоя? Мне кажется, это функциональность графических редакторов вроде Фотошопа
Мне snagit нравится позволяет сохранять проект
источник

M

Maeg in technicalwriters
Так, кажется, я как-то урезанно использую SnagIt
источник

VK

Vladimir Kozlov in technicalwriters
Maeg
Так, кажется, я как-то урезанно использую SnagIt
Сохранять необходимо в *.snag
источник

AB

Albina Brycheva in technicalwriters
Nick Volynkin
Вот это интересно. Вы хотите хранить картинку и выделение как два слоя? Мне кажется, это функциональность графических редакторов вроде Фотошопа
Типа того. Раньше использовала для этих целей Xara. Выше Александр подсказал про PowerPoint (я сейчас поигралась и оценила готовые объекты вроде стрелок, фигур).
Когда вела Руководства пользователей в Adobe InDesign, для редактирования картинок использовала Illustrator - в два клика из Индизайна открывается картинка в Иллюстраторе, мешяется скриншот, объекты остаются на месте и при сохранении картинвка в Руководстве обновляет автоматически
источник

M

Maeg in technicalwriters
Vladimir Kozlov
Сохранять необходимо в *.snag
и что это даст?
источник