Size: a a a

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

2021 October 13

NP

Nikolaj Potashnikov in DocOps-сообщество
Это Гиёму спасибо. Он же, кстати, сделал браузерные plug-ins для Asciidoctor'а
источник

VS

Vadim Smelyanskiy in DocOps-сообщество
Насчёт Mermaid обращу внимание, что года полтора у них с мейнтейнерами беда
https://github.com/mermaid-js/mermaid/issues/866

Те коммиты, которые есть в репозитории, в основном бампы версий зависимостей, адаптация под новые версии API этих зависимостей и т.д.
источник

VS

Vadim Smelyanskiy in DocOps-сообщество
На практике это значит, что добавление новых типов диаграмм заморожено

Но это не значит, что нельзя пользоваться)

Гантт у них отлично рисуется
источник

NV

Nick Volynkin in DocOps-сообщество
но всё равно там уже очень круто
источник

NV

Nick Volynkin in DocOps-сообщество
Такс, я сейчас удалил посты про Доку... и всё обсуждение тоже удалилось?
источник

NV

Nick Volynkin in DocOps-сообщество
Отстой, я не хотел удалять обсуждение
источник

NV

Nick Volynkin in DocOps-сообщество
в любом случае, вы правы: 1) это клон MDN, причем MDN безусловно лучше и 2) это похоже рекламный проект Яндекса, пусть сами себя рекламируют
источник

ЕЭ

Екатерина Эйрих... in DocOps-сообщество
ну вот, а я уже читаю, что за зверь такой эта Дока))))
источник

NV

Nick Volynkin in DocOps-сообщество
:)
источник

NK

ID:0 in DocOps-сообщество
Только что постил ссылку на проект с документацией по вебу. Спасибо читателям, что напомнили: есть документация Mozilla Developer Network, которая лучше и полнее. https://developer.mozilla.org/en-US/
источник

NK

ID:0 in DocOps-сообщество
В чате «Я шарю» сегодня спрашивали, как лучше начать использовать теги для документов в базе знаний. Сохраню здесь мой ответ. Всё это субъективно и основано на моем опыте использования и модерации StackOverflow, где есть очень четкие правила использования тегов.

1. Тегирование — это живой процесс, вы не сделаете его за один раз и навсегда. Просто начните размечать документы тегами. Смотрите, как люди ими пользуются. Делайте выводы, исправляйте ошибки, добавляйте новые теги, удаляйте ненужные.

2. Отдайте людям возможность добавлять новые теги, удалять ненужные, размечать статьи. Если это будет делать один назначенный менеджер знаний, то результат будет никому не нужен. Чтобы управлять общим процессом, вырабатывайте и доносите людям общие принципы.

3. Категорически не рекомендую сначала заниматься построением полной таксономии/онтологии и картированием знаний. Это очень удобный повод не делать настоящую работу, а вместо неё заниматься бесконечной подготовкой к работе.

4. Не используйте мета-теги: проблема, вопрос, статья, справка, инструкция и тому подобных. Тег описывает тему документа, а не его форму.

5. Не используйте слишком частные теги. Если тег похож на заголовок документа и применим только к нему одному — этот тег идёт в мусорку. Тег должен быть применим хотя бы к 5% документов. (Конкретный уровень вы сами можете установить).
источник

N

Nick in DocOps-сообщество
Спасибо, очень толково, причём не только для документации, но даже для локальной файлопомойки.
Попробую применить как харды приедут.
источник

CV

Cro Vin in DocOps-сообщество
Небольшой комментарий. К последним пунктам.

В своё время запомнилась рекомендация для написания статей относительно выбора ключевых слов.
Ключевые слова не должны повторять заголовок статьи и дублировать часто повторяемые термины в статье.
Ключевые слова должны отражать вне контекста основное содержание статьи.

Очень похоже с тем, что вы написали, мне по крайней мере таким показалось
источник

NV

Nick Volynkin in DocOps-сообщество
Это про ключевые слова для SEO? Согласен, похоже
источник

FM

Fox Mulder in DocOps-сообщество
Ник, это проект Вадима Макеева. Сам Макеев достаточно известный основоположник стандартов в мире html. Думаю, что даже если проект данный был спонсирован Яндекс, то это не так уж и плохо.
источник

V

Vitaly in DocOps-сообщество
Вадима уважаю как специалиста, но какое отношение имеет его авторитет к тому, что этот проект — просто плохая копия мдн?
источник

FM

Fox Mulder in DocOps-сообщество
Я не согласен с тем, что это клон.
источник

ГН

Геннадий Н in DocOps-сообщество
Блин, а я минут 5 уже ищу. Кучу ключевых перебрал(
источник

ME

Maria Ermakovich in DocOps-сообщество
MDN кстати на последней конференции Write The Docs активно искали контрибьюторов. хорошая возможность пополнить портфолио новичкам
источник

NK

Nata Kazakova in DocOps-сообщество
вот сегодня есть шанс узнать как это делать :) как раз на примере MDN
источник