VU
"И он дважды кликнул свою верную мышь"
Size: a a a
2021 February 02
VW
"И он дважды кликнул свою верную мышь"
В голос.
A
"И он дважды кликнул свою верную мышь"
ее верную мышь
(извините)
(извините)
ML
и потом пишете «прицельтесь снежно-белой стрелой в глянцевый рубиновый центр эфемерной «кнопки», ощущая, как под подушечкой пальца с легким щелчком сопротивления проминается лепесток мыши»?)
надо бы включить что-то подобное в нашу документацию и подождать реакции
A
надо бы включить что-то подобное в нашу документацию и подождать реакции
отличный способ проверить, читают ли документацию
A
но можно разочароваться в аудитории(
LR
ID:0
Привет! Меня зовут Николай Волынкин и я руковожу командой документации Tarantool.
Ищу технического писателя с хорошим письменным английским и русским, который умеет и любит:
— работать со сложной предметной областью: самостоятельно разбираться в ней и закапываться в детали;
— структурировать информацию, объяснять сложные штуки понятным языком и находить удачные формулировки;
— думать и заботиться о читателях, изучать их и совершенствовать свою работу.
Будет полезен опыт разработки, администрирования или работы в техподдержке. Здорово, если вы знакомы хотя бы с Git, командной строкой и языками разметки. Если не знакомы, мы вас научим за пару недель.
Про что мы пишем
— Tarantool («Тарáнтул») — база данных и сервер приложений, работающие в оперативной памяти, то есть очень быстро. В Tarantool можно писать логику обработки данных на языке Lua. Это тоже очень быстро работает и удобно в разработке*.
— Cartridge — конструктор для разработки и управления кластером баз данных.
— Tarantool Data Grid (далее TDG) — платформа для анализа данных, которой удобно пользоваться не-разработчикам.
— Модули Tarantool, коннекторы для разных языков программирования, инструменты для развертывания.
В ближайшие полгода-год вы будете писать в основном про Cartridge и TDG. Про первый мы пишем на английском. Про второй пока что на русском, но есть план перехода на английский. Документацию для новой версии TDG нужно будет писать во многом с чистого листа.
* Пишу упрощенно. Если вы видите тут кучу ошибок, то вы, наверное, разработчик. Для вас есть другая вакансия.
В чем ценность документации
Тарантул — внутренняя разработка компании Mail.Ru Group. Компания использует его во многих своих проектах (например, почта и облачный сервис МСS). Есть и внешние пользователи. Обычно это крупные банки и телекомы.
Хорошая документация очень важна для внутренних и внешних пользователей, продаж и успеха заказной разработки. Наши разработчики радеют за хорошие доки, охотно помогают нам с ревью и часто пишут сами.
Кто нас читает
— Разработчики в команде Tarantool, в других подразделениях компании и во всём мире. Для них мы пишем про устройство базы данных, разработку приложений на Lua и другой хардкор.
— Разработчики, которые интегрируют Tarantool в другие системы. Для них мы описываем API коннекторов на C++, Python, PHP, Go и Java.
— Администраторы, которые занимаются развертыванием, мониторингом и поддержкой инсталляций Tarantool, Cartridge и TDG. У нас есть Ansible-роль для развертывания «на железо» и оператор для Kubernetes. Про всё это мы тоже пишем.
— Аналитики, которые используют в своей работе веб-интерфейс TDG. Им мы рассказываем про интерфейсы и сценарии в них.
Как мы работаем
Используем подход «документация как код». Пишем исходники документации на языке разметки, версионируем с помощью Git, все задачи и ревью (рецензирование) — на GitHub. Благодаря этому у нас всё публикуется за 10-15 минут, форматирование не ломается, тексты не теряются, картинки не пропадают. Про любую строку можем сказать, кто, когда и зачем её редактировал.
Ядро Tarantool — продукт с открытым исходным кодом. Большая часть исходников документации тоже открыта и лежит на GitHub. Командный стайлгайд ведём в общей документации.
В команде есть свой разработчик. Он делает для нас инструменты и автоматизацию. Проверять корректность разметки и качество документа нам помогают автотесты. Пока что они совсем простые, скоро их будет больше. По сайту собираем пользовательскую аналитику и отзывы, учитываем их при планировании задач. Раньше сами переводили с английского на русский, сейчас внедряем непрерывную локализацию и отдаём переводы на аутсорс.
Если интересны детали — мы используем Sphinx, reStructuredText, немного Markdown, локально собираем в Docker, используем GitLab CI и Travis, но переезжаем на GitHub Actions, в тесты добавим Vale.
Как откликнуться на вакансию
Пишите на n.volynkin@corp.mail.ru с пометкой
Ищу технического писателя с хорошим письменным английским и русским, который умеет и любит:
— работать со сложной предметной областью: самостоятельно разбираться в ней и закапываться в детали;
— структурировать информацию, объяснять сложные штуки понятным языком и находить удачные формулировки;
— думать и заботиться о читателях, изучать их и совершенствовать свою работу.
Будет полезен опыт разработки, администрирования или работы в техподдержке. Здорово, если вы знакомы хотя бы с Git, командной строкой и языками разметки. Если не знакомы, мы вас научим за пару недель.
Про что мы пишем
— Tarantool («Тарáнтул») — база данных и сервер приложений, работающие в оперативной памяти, то есть очень быстро. В Tarantool можно писать логику обработки данных на языке Lua. Это тоже очень быстро работает и удобно в разработке*.
— Cartridge — конструктор для разработки и управления кластером баз данных.
— Tarantool Data Grid (далее TDG) — платформа для анализа данных, которой удобно пользоваться не-разработчикам.
— Модули Tarantool, коннекторы для разных языков программирования, инструменты для развертывания.
В ближайшие полгода-год вы будете писать в основном про Cartridge и TDG. Про первый мы пишем на английском. Про второй пока что на русском, но есть план перехода на английский. Документацию для новой версии TDG нужно будет писать во многом с чистого листа.
* Пишу упрощенно. Если вы видите тут кучу ошибок, то вы, наверное, разработчик. Для вас есть другая вакансия.
В чем ценность документации
Тарантул — внутренняя разработка компании Mail.Ru Group. Компания использует его во многих своих проектах (например, почта и облачный сервис МСS). Есть и внешние пользователи. Обычно это крупные банки и телекомы.
Хорошая документация очень важна для внутренних и внешних пользователей, продаж и успеха заказной разработки. Наши разработчики радеют за хорошие доки, охотно помогают нам с ревью и часто пишут сами.
Кто нас читает
— Разработчики в команде Tarantool, в других подразделениях компании и во всём мире. Для них мы пишем про устройство базы данных, разработку приложений на Lua и другой хардкор.
— Разработчики, которые интегрируют Tarantool в другие системы. Для них мы описываем API коннекторов на C++, Python, PHP, Go и Java.
— Администраторы, которые занимаются развертыванием, мониторингом и поддержкой инсталляций Tarantool, Cartridge и TDG. У нас есть Ansible-роль для развертывания «на железо» и оператор для Kubernetes. Про всё это мы тоже пишем.
— Аналитики, которые используют в своей работе веб-интерфейс TDG. Им мы рассказываем про интерфейсы и сценарии в них.
Как мы работаем
Используем подход «документация как код». Пишем исходники документации на языке разметки, версионируем с помощью Git, все задачи и ревью (рецензирование) — на GitHub. Благодаря этому у нас всё публикуется за 10-15 минут, форматирование не ломается, тексты не теряются, картинки не пропадают. Про любую строку можем сказать, кто, когда и зачем её редактировал.
Ядро Tarantool — продукт с открытым исходным кодом. Большая часть исходников документации тоже открыта и лежит на GitHub. Командный стайлгайд ведём в общей документации.
В команде есть свой разработчик. Он делает для нас инструменты и автоматизацию. Проверять корректность разметки и качество документа нам помогают автотесты. Пока что они совсем простые, скоро их будет больше. По сайту собираем пользовательскую аналитику и отзывы, учитываем их при планировании задач. Раньше сами переводили с английского на русский, сейчас внедряем непрерывную локализацию и отдаём переводы на аутсорс.
Если интересны детали — мы используем Sphinx, reStructuredText, немного Markdown, локально собираем в Docker, используем GitLab CI и Travis, но переезжаем на GitHub Actions, в тесты добавим Vale.
Как откликнуться на вакансию
Пишите на n.volynkin@corp.mail.ru с пометкой
[Вакансия] в заголовке. Прикрепите резюме в формате PDF или DOCX. Здорово, если добавите ссылки на примеры ваших текстов. С вопросами приходите в личку @nick_volynkin.
А где в репозитории доков лежат автотесты, если не секрет?
ML
А где в репозитории доков лежат автотесты, если не секрет?
могу рассказать, где и как у нас лежат
LR
могу рассказать, где и как у нас лежат
Да, пожалуйста!
ML
ща попробую.
вот есть страница: https://flussonic.com/doc/digital-video-recording-dvr/cluster-dvr/
на ней есть кусок кода:
в исходнике написано такое:
вот есть страница: https://flussonic.com/doc/digital-video-recording-dvr/cluster-dvr/
на ней есть кусок кода:
cluster_key abcd;
source streamer:8081 {
dvr /storage 2d;
}
в исходнике написано такое:
Clustering of DVR in Flussonic can be turned on easily: use the `source` directive to receive the video:
<snippet id="restreamer_dvr1.conf">
cluster_key abcd;
source streamer:8081 {
dvr /storage 2d;
}
</snippet>
In this case,
ML
ща попробую.
вот есть страница: https://flussonic.com/doc/digital-video-recording-dvr/cluster-dvr/
на ней есть кусок кода:
в исходнике написано такое:
вот есть страница: https://flussonic.com/doc/digital-video-recording-dvr/cluster-dvr/
на ней есть кусок кода:
cluster_key abcd;
source streamer:8081 {
dvr /storage 2d;
}
в исходнике написано такое:
Clustering of DVR in Flussonic can be turned on easily: use the `source` directive to receive the video:
<snippet id="restreamer_dvr1.conf">
cluster_key abcd;
source streamer:8081 {
dvr /storage 2d;
}
</snippet>
In this case,
дальше в том же репозитории лежат тесты на cypress
cypress/integration/cluster/dvr.js:
и там прям проверяется, что после втыкания такого куска конфига, на сервере в гуе появляются нужные явления:
cypress/integration/cluster/dvr.js:
и там прям проверяется, что после втыкания такого куска конфига, на сервере в гуе появляются нужные явления:
it('disk', () => {
cy.addDocUrl('https://flussonic.com/doc/digital-video-recording-dvr/cluster-dvr/');
//load config
cy.fixture('header.txt').as('header').then((header) => {
cy.fixture('restreamer_dvr1.conf').as('body').then((body) => {
cy.log(header + body);
cy.updateConfig(header + body);
})
})
cy.wait(10000); //wait for some dvr to be written
cy.visit(getPathUrl(`mirror/1/dvr`));
cy.get('[data-testid="mirrored-example"]')
cy.get(ui.dvrPath, { timeout: 5000 }).should('have.value', '/storage');
cy.visit(getPathUrl(`mirrored/example/dvr`));
cy.waitForDVR();
cy.getDVR('example').then((res) => {
expect(res[0].ranges[0].duration).to.not.equal(null);
})
});LR
Спасибо!
ML
это очень на пальцах
ML
соответственно к фолианту у нас есть расширение, которое вот эти snippets извлекает в файлы на диске, а cypress их читает
NV
Слишком много букв)
Думаю, сообщение лучше на 2 разделить. Или же просто часть инфы отдать HR для собеседования.
К концу я, например, уже утомилась, да и забыла о чем была речь в самом начале.
Думаю, сообщение лучше на 2 разделить. Или же просто часть инфы отдать HR для собеседования.
К концу я, например, уже утомилась, да и забыла о чем была речь в самом начале.
Мы ещё и тестовое предложим написать, там вообще скучно. :)
ЮГ
Мы ещё и тестовое предложим написать, там вообще скучно. :)
Ураа :)
NV
В качестве ремарки.
Хорошее подробное описание — это ещё не всё. Надо понимать интерес: сколько готовы платить, есть ли соц пакет или релокейшн пакет, в случае с вариантом офиса, обеспечивают ли техникой, например MBP, готовы ли купить нужный софт, оплачивать те же курсы, например.
Пока, кроме технологий и docs as code, ничего интересного.
Хорошее подробное описание — это ещё не всё. Надо понимать интерес: сколько готовы платить, есть ли соц пакет или релокейшн пакет, в случае с вариантом офиса, обеспечивают ли техникой, например MBP, готовы ли купить нужный софт, оплачивать те же курсы, например.
Пока, кроме технологий и docs as code, ничего интересного.
Я рассказал про то, что важно мне: большие задачи, принципы работы, команда, предметная область. Допускаю, что где-то есть писатели, которым больше важно, выдают ли макбук и хорош ли кофе в офисе. Но я ищу не их.
Я хочу найти прекрасных людей, которых мотивирует всё то же, что и меня, и с которыми мы вместе будем сворачивать горы. Для таких людей у нас есть макбук и другое железо, соцпакет, ДМС, релокация, фитнес-клуб в офисе, любой нужный софт, конференции, обучение, всё что угодно. Только, пожалуйста, будьте и дальше такими же восхитительными, пишите классные тексты, работайте в команде, растите и развивайтесь.
Я хочу найти прекрасных людей, которых мотивирует всё то же, что и меня, и с которыми мы вместе будем сворачивать горы. Для таких людей у нас есть макбук и другое железо, соцпакет, ДМС, релокация, фитнес-клуб в офисе, любой нужный софт, конференции, обучение, всё что угодно. Только, пожалуйста, будьте и дальше такими же восхитительными, пишите классные тексты, работайте в команде, растите и развивайтесь.
NV
ну это смотря как определять слово «продавать»
если я в поиске интересной работы под свои скиллы, то я очень оценю хорошо расписанные решаемые задачи, инструментальный стек, векторы развития
если я в поиске, гм, соцпакета и чуть больших денег, а остальное мне не очень важно — тогда я расстроюсь, что об этом не написано «во первых строках»
думаю, что Коля больше заинтересован в первой группе кандидатов:)
если я в поиске интересной работы под свои скиллы, то я очень оценю хорошо расписанные решаемые задачи, инструментальный стек, векторы развития
если я в поиске, гм, соцпакета и чуть больших денег, а остальное мне не очень важно — тогда я расстроюсь, что об этом не написано «во первых строках»
думаю, что Коля больше заинтересован в первой группе кандидатов:)
да, всё так
ML
Ну это же история про «Господин Журден и не подозревал, что вот уже более сорока лет разговаривет прозой»
Закона нет, как нет и четкого мерила, что считать канцеляритом
Но если человек в нем пишет и пишет много лет, то переучить его — довольно трудоемкая задача. Наверняка выполнимая, но трудоемкая
Закона нет, как нет и четкого мерила, что считать канцеляритом
Но если человек в нем пишет и пишет много лет, то переучить его — довольно трудоемкая задача. Наверняка выполнимая, но трудоемкая
просто иногда возникает ощущение, что есть какая-то тайная гильдия ассасинов-канцеляритов, которые из тьмы приставляют заточенное перо к горлу человека и требуют писать «подходят к концу денежные средства»
NV
надо бы включить что-то подобное в нашу документацию и подождать реакции
мне несколько человек написали про «Если вы видите тут кучу ошибок, то вы, наверное, разработчик». Дочитали )