Size: a a a

technicalwriters

2021 March 17

OR

Olga Rodina in technicalwriters
В интернете никто не узнает, что ты - котик
источник

MS

Maria Shabanova in technicalwriters
Albina Brycheva
Возник вопрос. Сейчас в компании разрабатываем новую базу знаний для ПО. Выбрали ДокуВики для этих целей. Для меня это новая система. Так вот онлайн-справки будут содержать примеры меню, окон программы и требуется выделять цветом, рамками на скриншотах элементы меню.
Посоветуйте, пожалуйста, в каком графическом редакторе это лучше сделать для ускорения процесса?
У меня пиратский Snagit)
источник

JU

Jxhnny Ut8h in technicalwriters
источник

AB

Albina Brycheva in technicalwriters
Александр Парень
Но из бесплатных мне больше xwiki импонирует
Просмотрела сайт. И правда очень симпатичный движок. Если не затруднит, в двух словах можете рассказать, в чем его основное преимущество перед ДокуВики.
Руководство поставило перед фактом -  выдали доступ на уже развернутый сервер ДокуВики и сказали "писать".  Но есть шанс переубедить, пока не приступлю полноценно к работе
источник

АП

Александр Парень... in technicalwriters
Albina Brycheva
Просмотрела сайт. И правда очень симпатичный движок. Если не затруднит, в двух словах можете рассказать, в чем его основное преимущество перед ДокуВики.
Руководство поставило перед фактом -  выдали доступ на уже развернутый сервер ДокуВики и сказали "писать".  Но есть шанс переубедить, пока не приступлю полноценно к работе
Ну как по мне это нормальный WYSIWYG-редактор, куча всяких плагинов. Да есть свои нюансы opensource, но терпимо. DokuWiki она чуть проще, в основном редактирование через wiki-разметку, и вроде он не умел делать копипаст рисунков из буфера обмена, а это снижает скорость написания статей. Ну это так, коротко. Есть еще MediaWiki, а некоторые прямо базу знаний на Gitlab разворачивали
источник

JU

Jxhnny Ut8h in technicalwriters
Александр Парень
Я пользую ShareX + PowerPoint, так как часто надо переверствать, затем всё в png.
ShareX впечатляет :) спасибо
источник

AB

Albina Brycheva in technicalwriters
Александр Парень
Ну как по мне это нормальный WYSIWYG-редактор, куча всяких плагинов. Да есть свои нюансы opensource, но терпимо. DokuWiki она чуть проще, в основном редактирование через wiki-разметку, и вроде он не умел делать копипаст рисунков из буфера обмена, а это снижает скорость написания статей. Ну это так, коротко. Есть еще MediaWiki, а некоторые прямо базу знаний на Gitlab разворачивали
Спасибо 👍. Да, копипаст не умеет делать ДокуВики, насколько я поняла из непродолжительного чтения мануала. Буду изучать тему далее
источник

JU

Jxhnny Ut8h in technicalwriters
Александр Парень
Ну как по мне это нормальный WYSIWYG-редактор, куча всяких плагинов. Да есть свои нюансы opensource, но терпимо. DokuWiki она чуть проще, в основном редактирование через wiki-разметку, и вроде он не умел делать копипаст рисунков из буфера обмена, а это снижает скорость написания статей. Ну это так, коротко. Есть еще MediaWiki, а некоторые прямо базу знаний на Gitlab разворачивали
у доку есть один важный для некоторых плюс — она на текстовых файлах, без бд
источник

АП

Александр Парень... in technicalwriters
Jxhnny Ut8h
у доку есть один важный для некоторых плюс — она на текстовых файлах, без бд
Ну чисто технически да, но по удобству из бесплатных xwiki мне по душе)
источник

AB

Albina Brycheva in technicalwriters
Jxhnny Ut8h
у доку есть один важный для некоторых плюс — она на текстовых файлах, без бд
это был основной аргумент За у руководства, к слову
источник

АП

Александр Парень... in technicalwriters
Вот @AbashkinIvan рассказывал свой путь про внедрения баз знаний
источник

АП

Александр Парень... in technicalwriters
Переслано от Ivan Abashkin
История про базу знаний внутри компании.

Около 5 лет я выстраивал службу поддержки клиентов. Сфера технически сложная. Много нюансов в инженерной части. Небольшие вариации обстановки у Клиента в корне могут поменять процесс работы над его проблемой. Поэтому специалистам поддержки очень много информации необходимо держать в голове, чтобы в онлайн-режиме подстраивать диалог, направляя его в нужное русло.
Продукты, которые мы поддерживали, так же технически сложные. Необходимо помнить как именно работают эти штуки их ттх и нюансы взаимодействия с внешним миром.

В компании была развернута MediaWiki, но ею никто не пользовался - слишком муторно.
В то время я уже использовал Evernote для ведения собственной базы знаний по работе. Предложил коллегам воспользоваться моими наработками. Получил от них положительные отзывы, некоторые даже начали писать туда свои статьи.
Потихоньку база знаний в Evernote наполнялась и был реально заметен эффект от её существования.

Но я всё равно был не доволен. В коллективе знания продолжали теряться. Люди из раза в раз ходили по одним и тем же граблям.

Я обратился к подходу Knowledge Centered Support (KCS). Его основная идея состоит в том, чтобы сотрудник после решения проблемы клиента, оставлял в системе ссылку на статью, по которой решается эта проблема. Если такой статьи нет, то сотрудник обязан её написать, законспектировав каким именно способом он решил проблему.

Параллельно внутренней базе знаний я взялся за организацию внешней: портала поддержки, где пользователи могли сами найти ответы.
Статьи в общем доступе должны быть качественные. Проработанные, понятные, красивые. Совсем не такие, какие мы позволяли себе вести во внутренней БЗ.

Нужно было выстраивать процесс по накоплению знаний. Когда сначала человек делает себе заметку. Потом превращает заметку в статью для коллег во внутренней БЗ. А потом выбираются наиболее популярные статьи и прорабатываются до уровня возможности выложить их на публику.

Чтобы всё это работало, нужно иметь несколько разных инструментов:
- Система, в которой определяется востребованность статей. (У нас это было специализированное ПО, в котором сотрудники общались с клиентами. По количеству и типу вопросов можно было оценить, что наиболее востребовано клиентами)
- Система, позволяющая быстро создавать личные заметки. (Здесь у нас до поры, до времени отлично справлялся Evernote)
- Система, позволяющая разворачивать личные заметки в более подробные статьи (Тут Evernote то же справлялся, но уже хуже. Для понимания на каком этапе находится конкретная заметка, нужно было учить сотрудников работе с определенной системой тегов, а они тяжело в это въезжали. Так же напрягало, что было не отследить кто и когда внёс какие изменения. Тяжело было откатить версию статьи назад).
- Процесс работы над превращением внутренних статей в статьи для внешних пользователей.  (Здесь нам помогали технические писатели)
- Система, в которой выполнялась публикация статей для внешних пользователей. Она должна была хорошо индексироваться поисковиками и подсказывать клиентам о существовании статьи по их вопросу.
(В качестве системы для внешних пользователей мы сначала использовали Copiny, а потом переехали на UserEcho)

Зоопарк изрядный. Всё это работало довольно хреново. Тяжело было за всем следить.
источник

АП

Александр Парень... 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.
источник

AS

Anna Shibaeva in technicalwriters
Всем добрый вечер!
Intel рад анонсировать регистрацию на Intel Technical Writing School - школу для начинающих техписов и всех настоящих лингвистов – любителей и исследователей естественных и компьютерных языков, графоманов и фанатов оксфордской запятой! Мы расскажем вам о том, что такое техническое писательство, какие существуют стандарты в англоязычной (читай: интернациональной) технической документации для программного обеспечения, и какими знаниями и навыками надо обладать, чтобы работать техническим писателем в Intel.

Сейчас открыта регистрация на митап, который пройдет уже в эту пятницу, 19 марта, в 18:00 МСК!

🔹reStructuredText и Sphinx: основы использования
Спикер: Кевин Путнам, Software Engineer at Intel
Язык доклада: английский
reStructuredText (reST), язык разметки, широко применяющийся для проектов с открытым исходным кодом, поддерживает принцип удобочитаемости и масштабируемости. Sphinx, система документирования с открытым исходных кодом и с обширной библиотекой тем и расширений, была изначально написана для нужд документации языка Python. Вместе они представляют собой мощный инструментарий, который можно использовать для самых разнообразных документационных проектов. На этом занятии вы познакомитесь с базовым синтаксисом reStructuredText, в том числе посмотрите на разницу между ролями и директивами, а также узнаете, как трансформировать набор reST документов в проект Sphinx.

🔹Документирование программных интерфейсов: краткий обзор
Спикер: Екатерина Мехнецова, Technical Writer at Intel
Документирование программных интерфейсов – одна из важнейшних задач технического писателя. Подходы к API документации различаются в зависимости от специфики проекта и его целей. Мы обсудим подходы к документированию программных интерфейсов и посмотрим на примеры хорошей и плохой API документации.

❗️Регистрация по ссылке: http://bit.ly/3ctXH3o❗️

Спасибо!
источник

OR

Olga Revyakina in technicalwriters
Jxhnny Ut8h
я использую Snagit. но он платный
я покупала за 3500 рублей, и он стоит каждой потраченной копейки )
источник

VW

Vinni Winterlight in technicalwriters
Olga Revyakina
я покупала за 3500 рублей, и он стоит каждой потраченной копейки )
Удвою. Особенно приятно когда у тебя продукт проходит ИК или сертификацию каждый год. Из библиотеки можно быстро и удобно поднять архив изображений.
источник

AB

Albina Brycheva 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.
Какой интересный опыт! Спасибо.
Когда-нибудь и я напишу подробное, когда завершим перенос всех доков из хелпов, документов Indesign и Word в вики 😁. У нас Evernote тоже все любили, за исключением одного отдела, который принципиально отказывался писать там, предпочитая Word.
источник

NV

Nick Volynkin in technicalwriters
Albina Brycheva
Возник вопрос. Сейчас в компании разрабатываем новую базу знаний для ПО. Выбрали ДокуВики для этих целей. Для меня это новая система. Так вот онлайн-справки будут содержать примеры меню, окон программы и требуется выделять цветом, рамками на скриншотах элементы меню.
Посоветуйте, пожалуйста, в каком графическом редакторе это лучше сделать для ускорения процесса?
А почему выбрали ДокуВики? Какие ещё варианты рассматривали?
источник

NV

Nick Volynkin in technicalwriters
Albina Brycheva
Просмотрела сайт. И правда очень симпатичный движок. Если не затруднит, в двух словах можете рассказать, в чем его основное преимущество перед ДокуВики.
Руководство поставило перед фактом -  выдали доступ на уже развернутый сервер ДокуВики и сказали "писать".  Но есть шанс переубедить, пока не приступлю полноценно к работе
Берите Sphinx ;)
источник

AD

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