Как стать автором
Обновить

KnowledgeConf: Настало время делиться знаниями

Время на прочтение 15 мин
Количество просмотров 4.2K
Блог компании Конференции Олега Бунина (Онтико) Хранение данных *Управление разработкой *Управление проектами *Конференции
KnowledgeConf — новая конференция в семействе Ontico, мы хотим собрать на одной площадке тех, кто постоянно или время от времени занимается фиксацией, структурированием, организацией хранения и актуализацией знаний в технологических компаниях. Поговорим о том, как снижать риски потери уникальных знаний, как переиспользовать решения, как улучшать автобусный фактор, как быстрее онбордить новых сотрудников.



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

KnowledgeConf 2019, профессиональная конференция по управлению знаниями в IT компаниях пройдет 26 апреля 2019 на площадке ИнфоПространство в центре Москвы.

Что такое вообще знания, что за абстракция, спросите вы. Да, речь действительно идет не об алгоритмах, архитектурных паттернах или командах в системе контроля версий.
Читать далее
Всего голосов 31: ↑30 и ↓1 +29
Комментарии 3

Docs as code против или вместе с Confluence? Обзор нескольких способов публикации из репозитория в Confluence

Время на прочтение 7 мин
Количество просмотров 12K
Python *Управление проектами *Atlassian *Подготовка технической документации *
Многие уже давно или активно используют или смотрят в сторону модели хранения и публикации документации как кода, это значит применять к документации все те же правила, инструменты и процедуры, что и к программному коду, например, хранить в репозитории, прогонять тесты, собирать и релизить в CI/CD. Этот подход позволяет поддерживать документацию актуальной к коду, версионировать и отслеживать изменения, используя привычные инструменты разработки.

Однако в то же время во многих компаниях годами существуют также и вики-системы, в которых к документации получают доступ другие команды и сотрудники, например, менеджеры проектов. Что если вам захотелось привести хранение и публикацию к единому виду, то есть наряду с HTML публиковать доки и в Confluence? В этой статье я дам обзор решений задачи публикации документов из репозитория в Confluence.
Читать далее
Всего голосов 16: ↑16 и ↓0 +16
Комментарии 15

Справочный центр Selectel: интерфейс, техническая реализация и возможности

Время на прочтение 8 мин
Количество просмотров 2.2K
Блог компании Selectel IT-инфраструктура *Git *Управление разработкой *
🔥 Технотекст 2020

Каждой предоставляемой услугой Selectel можно управлять в личном кабинете — панели управления. Многими нашими продуктами также возможно управлять через запросы к API. Инструкции по работе с продуктами и документация API доступны в едином справочном центре.

Основная идея справочного центра — предоставить нашим клиентам возможность в любое удобное для них время самостоятельно найти ответы на большинство интересующих их вопросов об услугах Selectel.

Далее расскажем о том, как мы изменили подход к подготовке документации и обновили внешний вид базы знаний.
Читать дальше →
Всего голосов 25: ↑24 и ↓1 +23
Комментарии 2

Docs as Code: введение в предмет

Время на прочтение 17 мин
Количество просмотров 17K
Блог компании Plesk Анализ и проектирование систем *Подготовка технической документации *

В последние несколько лет в среде технических писателей все больше на слуху концепция Docs as Code. Если вы раньше не сталкивались с этим термином, он обозначает подход к разработке технической документации с использованием тех же инструментов и процессов, что и написание кода. Если DocOps это про процессы и коллаборацию, то Docs as Code — про инструментарий, при помощи которого мы несмотря ни на что. Мы выбрали этот подход, когда создавали портал документации Plesk.

В этой статье я кратко расскажу, что такое Docs as Code и зачем оно нужно, а затем дам несколько советов относительно того, как это чудо враждебной техники внедрять, сдобрив всю историю рассказами о тех граблях, на которые мы наступили, топая в светлое будущее. Я старался писать такую статью, которая пригодилась бы мне в 2017 году, когда мы эту кашу заваривали.

Читать далее
Всего голосов 20: ↑20 и ↓0 +20
Комментарии 17

Сравнение возможностей AsciiDoc и DITA

Время на прочтение 7 мин
Количество просмотров 3K
Подготовка технической документации *

Всем лучи добра! Меня зовут Владимир Маркиев, я -- технический писатель в Docsvision. Расскажу вам о двух Docs as Code инструментах. На случай, если вы делали документацию в ворде или ещё где-то, а теперь решили отделить форматирование от документации и захотели "чтобы было чисто!". Побуду сегодня вашим Мистером Пропером.

Читать далее
Всего голосов 6: ↑6 и ↓0 +6
Комментарии 15

Уютный, но хардовый митап про системную аналитику

Время на прочтение 1 мин
Количество просмотров 700
Блог компании ЮMoney Карьера в IT-индустрии Конференции IT-компании

Команда ЮMoney проведёт митап про системную аналитику — уютный, но хардовый.

Темы докладов:
• Репозиторий архитектуры: 20 лет развития системы
• Documentation As Code, или «Легкий способ бросить вести документацию на wiki»
• Про сломанные грабли и разбитые лбы: проектирование в финтехе

Ждём вас 25 октября в 18:00 (мск).
Регистрируйтесь и зовите друзей: https://events.yoomoney.ru/analytics-code-2022.

Читать далее
Всего голосов 1: ↑1 и ↓0 +1
Комментарии 0

DocOps на Flow 2022

Время на прочтение 4 мин
Количество просмотров 2.1K
Блог компании JUG Ru Group Подготовка технической документации *
Обзор


29-30 ноября прошла конференция для аналитиков FlowConf 2022. Основная особенность конференции — ее ориентация на конкретные практические рецепты. Одним из направлений, которое содержит много таких рецептов, стал Docs As Code или, в более широком смысле, DocOps в работе аналитика. В посте представляю обзор этого направления.

Читать дальше →
Всего голосов 19: ↑19 и ↓0 +19
Комментарии 1

Docs as Code для художественной литературы. Делаем творческий сайт ребенка с помощью MkDocs

Уровень сложности Простой
Время на прочтение 13 мин
Количество просмотров 4.9K
Open source *GitHub *DIY или Сделай сам Подготовка технической документации *
Кейс


Docs as Сode — подход к работе с текстами, подразумевающий написание текста как кода:


  • в простом текстовом редакторе или IDE;
  • с использованием системы контроля версий;
  • с CI / CD / Code Review.

В настоящее время Docs as Code широко применяется при работе с технической документацией, давая техническим писателям и проектным командам массу удобств и преимуществ.


Но что если пойти дальше, попробовать такой подход не с техническими, а с художественными текстами? Что если автор — не технарь и не айтишник? Просто юный начинающий писатель, который пробует писать прозу и стихи ручкой на бумаге, и надеется познакомить широкую публику со своим творчеством?


В этой статье я расскажу о таком эксперименте (забегая вперед, удачном). Моей дочери 11 лет, она пишет сказки, стихи и рассказы. Чтобы поддержать ее увлечение, я помог ей создать литературный сайт, используя подход Docs as Code. Она успешно освоила основы Markdown и Git. Сейчас она самостоятельно публикует новые произведения и обновляет новости на своем сайте https://lib-beliakova.github.io/.

Читать дальше →
Всего голосов 44: ↑44 и ↓0 +44
Комментарии 17