Size: a a a

DocOps-сообщество

2020 December 20

M

Maeg in DocOps-сообщество
Maksim Lapshin
коллеги, а вы как-то пропускаете, для чего вы делаете документацию.

Кажется, здесь мало тех несчастных, которые тянут лямку «пишем по ГОСТу» и тем самым поддерживают этот безумный дьявольский обряд.

Кто _мерял_ на продакшне, как люди читают?  Кто ходит в глоссарий, кто нажимает на раскрытие хелпа и т.п.?
Как можно обсуждать эти вопросы без цифр кликов?
Мне довелось поработать с базой знаний, которую отдел поддержки (колл-центр, это всё) разрабатывал сам для себя - поддерживал, актуализировал, регулярно проводил внутренние экзамены. Там глоссарий был. Метрики были. Это так, в качестве примера.
источник

H

Hartmann in DocOps-сообщество
Кстати! Кто-то добавлял, настраивал метрики в SSG? Например, в том же Docusaurus, Hugo, Jekyll и тд? Везде через какие-то костыли это реализуется и то не всё. Пока, самые адекватные метрики с которыми я успел столкнуться — в GitBook. Всё из коробки работает и очень удобно.
источник

NV

Nick Volynkin in DocOps-сообщество
Если речь о пользовательской аналитике (Google Analytics, Яндекс Метрика, Hotjar...), то они же все добавляются одинаково вне зависимости от SSG.
источник

NV

Nick Volynkin in DocOps-сообщество
Hartmann
Кстати! Кто-то добавлял, настраивал метрики в SSG? Например, в том же Docusaurus, Hugo, Jekyll и тд? Везде через какие-то костыли это реализуется и то не всё. Пока, самые адекватные метрики с которыми я успел столкнуться — в GitBook. Всё из коробки работает и очень удобно.
Расскажи, как для тебя удобно и как неудобно?
источник

H

Hartmann in DocOps-сообщество
Nick Volynkin
Расскажи, как для тебя удобно и как неудобно?
Долго рассказывать, проще зайти в Гитбук и посмотреть на живом примере, как они всё реализовали.
Вот там есть и метрики по поиску ключевых слов, и по просматриваемым материалам, кто, что, куда кликает, что в первую очередь, что во вторую и тд.
источник
2020 December 21

ИЦ

Игорь Цупко... in DocOps-сообщество
Maksim Lapshin
какая разница, кто к чему привык со стороны техписателя? Вопрос только один:  это помогает клиенту решать его проблемы и, вследствие этого, компании зарабытывать деньги или нет
ооо, годные темы поднимаешь, низкий поклон
источник

FM

Fox Mulder in DocOps-сообщество
Кто подскажет, вот тут
[https: //www.youtube. com/watch?v=acy-5Ses9go]
в чём диаграмма рисовалась?
источник

ОИ

Олег Игонин... in DocOps-сообщество
Fox Mulder
Кто подскажет, вот тут
[https: //www.youtube. com/watch?v=acy-5Ses9go]
в чём диаграмма рисовалась?
источник

FM

Fox Mulder in DocOps-сообщество
Спасибо, видимо ослеп, ибо смотрел
источник

ОИ

Олег Игонин... in DocOps-сообщество
Проблема тут только с экспортом - платно. А вот общий доступ и редактирование - бесплатные.
источник

IC

Ivan Cheban in DocOps-сообщество
Коллеги, а какие есть инструменты создания дерева папок и файлов в маркдауне? Я находил несколько расширений в VSCode и команда tree в командной строке. Но не совсем нравится, что на выходе.
источник

IC

Ivan Cheban in DocOps-сообщество
Хочется в таком виде дерево
источник

BF

Bobba Fett in DocOps-сообщество
Ivan Cheban
Коллеги, а какие есть инструменты создания дерева папок и файлов в маркдауне? Я находил несколько расширений в VSCode и команда tree в командной строке. Но не совсем нравится, что на выходе.
Сгенерировать из своей фс или нарисовать произвольную структуру?
источник

IC

Ivan Cheban in DocOps-сообщество
Сгенерировать из существующей структуры папок дерево
источник

IC

Ivan Cheban in DocOps-сообщество
В моем проекте вот такая структура папок...
источник

FM

Fox Mulder in DocOps-сообщество
Ivan Cheban
Коллеги, а какие есть инструменты создания дерева папок и файлов в маркдауне? Я находил несколько расширений в VSCode и команда tree в командной строке. Но не совсем нравится, что на выходе.
я пользуюсь file-tree-generator
источник

FM

Fox Mulder in DocOps-сообщество
📦documentation
┣ 📂.git
┣ 📂admin-guide
┃ ┣ 📂modules
┃ ┃ ┣ 📂paas
┃ ┃ ┃ ┣ 📂assets
┃ ┃ ┃ ┃ ┗ 📂images
┃ ┃ ┃ ┣ 📂pages
┃ ┃ ┃ ┃ ┣ 📂bdaas
┃ ┃ ┃ ┃ ┃ ┗ 📜index.adoc
┃ ┃ ┃ ┗ 📜nav.adoc
┃ ┃ ┣ 📂ROOT
┃ ┃ ┃ ┣ 📂pages
источник

IC

Ivan Cheban in DocOps-сообщество
Да, я читал выше, что ты это используешь
источник

IC

Ivan Cheban in DocOps-сообщество
Но я хотел именно в таком виде, как я на скрине выше привел
источник

FM

Fox Mulder in DocOps-сообщество
Есть мысля, ща
источник