NV
У меня есть список именно каналов, если что: https://t.me/docops/418
Size: a a a
2020 September 02
EP
а мне все интересно, но меня раздражает обилие каналов, что делать?)
Мутить (mute) каналы и читать то, что считаете актуальным
AR
и так все каналы\чаты в mute, но каждый раз когда вы постите новый чат, канал, прям начинает напрягать, что я опять не в теме))
FM
А я сегодня вступил в канал любителей аскидока)
AR
о -))
MD
ID:0
Пишет Игорь Цупко, мой единомышленник и соратник по KnowledgeConf:
Привет, коллеги!
Последний год мы с коллегами из KnowledgeConf занимаемся систематизацией и исследованиями подходов к менеджменту знаний и оформляем это всё в виде Прагматичного Гайда.
Мы выработали ряд походов и понимание того, как запустить или сделать более эффективным онбординг, выстроить документирование, обмен знаниями, сформулировать и распространить лучшие технологические практики внутри команды и компании. И мы хотим поделиться этим знанием с вами.
Если вы сейчас ищете подходы улучшить процессы управления знаниями — давайте пообщаемся и обменяемся опытом. Редакции гайда будет полезно узнать об актуальных для разработчиков проблемах, а вы, возможно, пополните свою копилку хорошими практическими идеями.
Чтобы принять участие — забейте временной слот (30-40 минут) через Calendly. По возможности укажите при забивании слота — какие проблемы менеджмента знаний для вас актуальны, чтобы нам не терять времени.
Привет, коллеги!
Последний год мы с коллегами из KnowledgeConf занимаемся систематизацией и исследованиями подходов к менеджменту знаний и оформляем это всё в виде Прагматичного Гайда.
Мы выработали ряд походов и понимание того, как запустить или сделать более эффективным онбординг, выстроить документирование, обмен знаниями, сформулировать и распространить лучшие технологические практики внутри команды и компании. И мы хотим поделиться этим знанием с вами.
Если вы сейчас ищете подходы улучшить процессы управления знаниями — давайте пообщаемся и обменяемся опытом. Редакции гайда будет полезно узнать об актуальных для разработчиков проблемах, а вы, возможно, пополните свою копилку хорошими практическими идеями.
Чтобы принять участие — забейте временной слот (30-40 минут) через Calendly. По возможности укажите при забивании слота — какие проблемы менеджмента знаний для вас актуальны, чтобы нам не терять времени.
Пообщались сегодня с Игорем. На мой взгляд, очень продуктивно) Спасибо ему!
NV
Fox Mulder
А я сегодня вступил в канал любителей аскидока)
Покажи )
IC
Fox Mulder
А я сегодня вступил в канал любителей аскидока)
Это в телеграмме?
NK
Добавил чат любителей AsciiDoctor — @asciidoctor.
AsciiDoctor — это ещё один легковесный язык разметки и генератор документации для него. Язык разметки похож на reStructuredText: выразительный, семантический но сложнее и менее популярный, чем Markdown.
https://asciidoctor.org/docs/asciidoc-syntax-quick-reference/
AsciiDoctor — это ещё один легковесный язык разметки и генератор документации для него. Язык разметки похож на reStructuredText: выразительный, семантический но сложнее и менее популярный, чем Markdown.
https://asciidoctor.org/docs/asciidoc-syntax-quick-reference/
2020 September 05
RG
Переслано от Ramil G
Коллеги, а кто и как поддерживает актуальность пользовательской документации (help) на сайте? У нас в настоящий момент это делает один выделенный аналитик. Ему очень трудно уследить за всеми изменениями, поэтому бывает, что описание фич не попадает в доку, а бывает, что фич слишком много и аналитик просто не успевает. Думаю возложить обязанность писать доки по каждой фиче аналитиков, непосредственно ставящих задачи по этим фичам.
RG
Переслано от Ramil G
Также интересно вообще мнение и опыт относительно сборки пользовательской документации из doxygen и скриншотов при помощи selenium или pappeteer
NV
RG
Почему именно doxygen, надо код документировать?
Мы с разработчиками поговорили, решили, что надо делать самодокументируемый сайт. Чтобы у всех элементов на сайте был небольшой кусочек текста-пояснения. Эти пояснения будут делать разработчики фронта. Надо чтобы эти куски собирались автоматически в большую отдельную доку. Вместе со скриншотом элемента к которому они привязаны
RG
Пожалуй, это как сваггер :)
ML
Переслано от Ramil G
Коллеги, а кто и как поддерживает актуальность пользовательской документации (help) на сайте? У нас в настоящий момент это делает один выделенный аналитик. Ему очень трудно уследить за всеми изменениями, поэтому бывает, что описание фич не попадает в доку, а бывает, что фич слишком много и аналитик просто не успевает. Думаю возложить обязанность писать доки по каждой фиче аналитиков, непосредственно ставящих задачи по этим фичам.
мы сейчас сделали так: все сниппеты кода на сайте мы делаем куском теста. Т.е. если есть кусочек кода, настройки, чего-то ещё, то он должен быть прям с сайта засунут в автоматический тест (тест пишется руками под каждый сниппет) и проверен на работоспособность.
Если что-то хрустнет, значит что поведение поменялось
Если что-то хрустнет, значит что поведение поменялось
RG
мы сейчас сделали так: все сниппеты кода на сайте мы делаем куском теста. Т.е. если есть кусочек кода, настройки, чего-то ещё, то он должен быть прям с сайта засунут в автоматический тест (тест пишется руками под каждый сниппет) и проверен на работоспособность.
Если что-то хрустнет, значит что поведение поменялось
Если что-то хрустнет, значит что поведение поменялось
Ага, автотест является индикатором, что надо переписать доку... тоже неплохо
RG
А доку сама по себе живет? Доки никто не читает же
RG
Хотим, чтобы пояснения были на самом сайте, при этом, чтобы большую доку не приходилось поддерживать отдельно.
ML
это документация как раз на сайте
NV
мы сейчас сделали так: все сниппеты кода на сайте мы делаем куском теста. Т.е. если есть кусочек кода, настройки, чего-то ещё, то он должен быть прям с сайта засунут в автоматический тест (тест пишется руками под каждый сниппет) и проверен на работоспособность.
Если что-то хрустнет, значит что поведение поменялось
Если что-то хрустнет, значит что поведение поменялось
Это код для SDK, да? У нас много bash и cmd.exe, и я пока с трудом представляю, как на них написать тесты.