Александр Мачулин (Gramax) – Справочник фантастических тварей из Docs as Code

Transcript

1. Docs as Code, проблемы, решение Gramax Александр Мачулин Techdoc Meetup
2. По позициям: • Бизнес-аналитик. • Проектный менеджер, владелец продукта. • Директор по продуктам и проектам. По навыкам: • Писал ТЗ и документацию на системы. • Работал с SQL, Python, VB. • Писал код в проектах. Обо мне
3. Пишу ТЗ Что пишем: • Технические задания. • Документацию на систему. Кто пишет: • Бизнес-аналитик. • Проектный менеджер. Что по инструментам: • DOCX на Sharepoint. • Dropbox.Paper. • И в веб-интерфейсе систем. 2020 год
4. Технический директор предложил
5. • Удобное ревью благодаря Git-транзакциям. • Создание веток и их объединение. • CI/CD. • Статические сайты. • Асинхронное редактирование. Почему Docs as Code — это хорошо
9. Инструменты: • Язык разметки и редактор. • Markdown-превью. • Расширения для Markdown. • Git. • Git-хранилище. • Static site generator. • Диаграммы.
15. Не гуглить, а идти в ChatGPT.
18. Как снизить вред: • Обсуждать документацию только в таск-трекере. • Подключить плагин к static site generator.
21. Как снизить вред: • Сделать инструкцию, ориентированную только на работу в GitLab. • Принимать в команду только с опытом. • Общий аккаунт ChatGPT.
22. Что имеем в итоге: • Зоопарк инструментов и систем. • Сложное ежедневное использование. • Согласование с заказчиком вне плоскости Docs as Code. • Продолжительный поиск людей или онбординг.
25. Что сделали: • Объединили нужные инструменты в одно приложение. • Вынесли ключевые сценарии использования в простой интерфейс. • Добавили инлайн-комментарии в редактор. • Сделали ссылку на ревью в браузере.
29. @Alexvnder