Size: a a a

2019 September 13

KC

Kseniya Chudakova in technicalwriters
Alexandra Zolushkina
Привет!

Мы в JetBrains используем in-house solution для написания документации, в совершенствование которого мы уже несколько лет вкладываем много сил. Это и умный редактор, и язык разметки, и публикация, и front-end. Нас часто спрашивают коллеги, чем мы пользуемся, и мы думаем о том, чтобы сделать наш продукт публичным.

Сейчас мы проводим исследование, чтобы понять, какие инструменты сейчас наиболее популярны, и можем ли мы предложить писателям что-то, что не покрыто имеющимися инструментами. Будет здорово, если вы сможете поделиться с нами вашим опытом! В качестве приятного бонуса мы разыграем 5 сертификатов на 50 долларов на Amazon среди ответивших.
https://surveys.jetbrains.com/s3/authoring-tools-tg

Спасибо!
WebStorm❤️ — покрывает почти все мои потребности как техписа
источник

ET

Eduard Tibet in technicalwriters
Alexandra Zolushkina
Привет!

Мы в JetBrains используем in-house solution для написания документации, в совершенствование которого мы уже несколько лет вкладываем много сил. Это и умный редактор, и язык разметки, и публикация, и front-end. Нас часто спрашивают коллеги, чем мы пользуемся, и мы думаем о том, чтобы сделать наш продукт публичным.

Сейчас мы проводим исследование, чтобы понять, какие инструменты сейчас наиболее популярны, и можем ли мы предложить писателям что-то, что не покрыто имеющимися инструментами. Будет здорово, если вы сможете поделиться с нами вашим опытом! В качестве приятного бонуса мы разыграем 5 сертификатов на 50 долларов на Amazon среди ответивших.
https://surveys.jetbrains.com/s3/authoring-tools-tg

Спасибо!
А мне хотелось бы задать немного другой вопрос. Почему JetBrains пользовался Confluence на протяжении более 10 лет и не отказывался от него вплоть до последнего времени (насколько я понимаю, отказ произошел только в 2017-2018 году)? В то время, как уже давно существовали markup languages (в данном случае, неважно, речь идет о lightweight или xml-based markups), которые позволяют хранить контент в репозитории (svn, git, mercurial, etc).
источник

AG

Anna Gasparyan in technicalwriters
Отвечаю, как представитель JetBrains. Confluence использовался в недавнем прошлом как инструмент написания документации только небольшим количеством команд, где помимо писателей в документацию контрибьютили разработчики и не хотели заморачиваться ничем более продвинутым. Сейчас документация вся в едином формате и на confluence не пишется. Если остались какие-то туториалы, это legacy, которое постепенно должно исчезнуть
источник

J

Julia in technicalwriters
Eduard Tibet
А мне хотелось бы задать немного другой вопрос. Почему JetBrains пользовался Confluence на протяжении более 10 лет и не отказывался от него вплоть до последнего времени (насколько я понимаю, отказ произошел только в 2017-2018 году)? В то время, как уже давно существовали markup languages (в данном случае, неважно, речь идет о lightweight или xml-based markups), которые позволяют хранить контент в репозитории (svn, git, mercurial, etc).
я бы вообще сказала, что Confluence и языки разметки - это подходы, которые решают разные задачи в зависимости от целей конкретного проекта
источник

J

Julia in technicalwriters
и сравнивать их в плане "что лучше" не стоит
источник

AG

Anna Gasparyan in technicalwriters
Kseniya Chudakova
WebStorm❤️ — покрывает почти все мои потребности как техписа
Markdown + GitHub?
источник

KC

Kseniya Chudakova in technicalwriters
Anna Gasparyan
Markdown + GitHub?
Git + движок для html и другие надстройки
источник

KC

Kseniya Chudakova in technicalwriters
не обязательно ипользовать GitHub в таком случае
источник

ET

Eduard Tibet in technicalwriters
Julia
я бы вообще сказала, что Confluence и языки разметки - это подходы, которые решают разные задачи в зависимости от целей конкретного проекта
Вопрос был задан немного в другом русле. Как известно, разработчики очень любят работать с системой контроля и с src-файлами. С учетом того, что в JetBrains достаточно продвинутые разработчики (и не только разработчики :), вопрос и был в том, почему они _изначально_ не использовали src-based documentation (назовем ее так), а использовали именно Confluence.
источник

AG

Anna Gasparyan in technicalwriters
Eduard Tibet
Вопрос был задан немного в другом русле. Как известно, разработчики очень любят работать с системой контроля и с src-файлами. С учетом того, что в JetBrains достаточно продвинутые разработчики (и не только разработчики :), вопрос и был в том, почему они _изначально_ не использовали src-based documentation (назовем ее так), а использовали именно Confluence.
Если это правда так интересно, могу попробовать узнать у выживших динозавров :) когда я пришла 5.5 лет назад, мы пользовались Perforce, потом перешли на git
источник

ET

Eduard Tibet in technicalwriters
Anna Gasparyan
Если это правда так интересно, могу попробовать узнать у выживших динозавров :) когда я пришла 5.5 лет назад, мы пользовались Perforce, потом перешли на git
Да, да, это было бы очень интересно. И вот почему. В бытность работы в одной из компаний я был идеологом создания системы документирования, где все собиралось из исходников. Мы с коллегами из отдела сделали inhouse-систему, которая хранила все в системе контроля и собирала в режиме on-fly, on-demand. Т.е. это даже не SSG - это динамическая (!) сборка документации на основе конвейеров Apache Cocoon. Эта система была создана в 2008 (!!!) году. Когда я в то время смотрел на документацию jetbrains (а она была в Confluence), меня занимал вопрос, почему Jetbrains не использует преимущества систем контроля для документации с его diff, merge и т.п.? Для интересующихся стек технологий этого in-house решения: DocBook/XML 4.5 (doc-src), XMLMind (WYSIWYM-редактор), subversion (scm), проверка содержимого и информирование авторов с помощью email при каждом commit, сообщения об ошибках - только на валидность и well-formеdness (cхематрон на использовался), XInclude (content reuse), препроцессинг и генерация olink db (при помощи простейшего bash скрипта),  динамическая генерация представления (html, PDF, txt) по http GET (в зависимости от устройства пользователя) с помощью Apache Cocoon (XML Publishing Framework), логика отображения и адаптивное представление (на основе конвейеров Cocoon), кэширование (внутренние механизмы Cocoon).
источник

OY

Olga Yesina in technicalwriters
поделитесь примером технического отчета на английском языке и описание API. может попадался в открытом доступе🙏🏻
источник

SY

Sofia Yemelianova in technicalwriters
описаний API в инете куча, берете и гуглите любой серьезный проект с аудиторией из разработчиков и добавляете аббревиатуру API. что имеется в виду под “техничским отчетом”?
источник

SY

Sofia Yemelianova in technicalwriters
мне вот нравится https://stripe.com/docs/api. интересно, какой у них стек…
источник

SP

Sergey Protsenko in technicalwriters
В этом курсе был где-то список из порядка 100 сайтов с документацией на различные api
https://github.com/docops-hq/learnapidoc-ru/blob/master/testing-api-doc/README.md
источник

OY

Olga Yesina in technicalwriters
о, спасибо! а по отчетам?
источник

L

Luiza in technicalwriters
источник
2019 September 14

СФ

Семён Факторович in technicalwriters
В продолжение вчерашнего разговора про инструменты:
источник

СФ

Семён Факторович in technicalwriters
источник
2019 September 16

АП

Александр Парень in technicalwriters
источник