knowledgebase

Статьи

Статьи были перенесены из гугл таблицы.

Содержание

• Статьи для технического писателя
• Работа с текстом
• О профессии
• Про стандарты

Статьи для технического писателя

• Как техпису изложить фактуру в техдоке?
• Как научиться писать статьи (для Хабра и не только)
• Вам кажется, что с вашей документацией что-то не так? Вам не кажется
• Создание системы документирования, или как мы от «ворда» к docs as code за месяц переходили
• Про важность документирования
• Как мы в «Активе» пишем пользовательскую документацию. Почему это важно
• Как заголовок и навигация в документации помогают минимизировать стресс пользователя
• Внешний вид и скриншоты в пользовательской документации. Как надо и не надо делать
• Предпроектное обследования при разработке информационной системы
• Кровь, пот и слезы: как я переделал навигацию на сайте документации и в чём профит переделки
• Жизненный цикл инфраструктурной документации: документируй это от заката до рассвета
• 7 правил написания технической документации мирового класса
• Летопись проекта: зачем нужна инфраструктурная документация
• Как снять обучающий видеоролик: 10 секретов технического писателя
• Почему пользователи не читают документацию или как можно улучшить руководство пользователя
• В поисках минимального ТЗ
• О нормах и законах или Как вылечить процесс техдокументирования (спойлер: это больно)
• Автоматизация оформления документации
• Пишем техническую документацию: руководство для непрофессионала
• Как тестировать документацию. Простой алгоритм
• Делаем документацию здорового человека в Git на примере Docs Ozon
• Docs as Code для художественной литературы. Делаем творческий сайт ребенка с помощью MkDocs
• Как писать и продвигать White Paper?
• Юзер-стори идеальная, а багов 100500? Как мы тестируем документацию
• Визуализация ТЗ — диаграммы, схемы, картинки
• Нефункциональные требования: как не пустить систему ко дну
• Что нужно знать о применении шрифтов
• Зачем оформлять документы о создании программного обеспечения (мнение практикующего юриста)
• Идентификация, аутентификация и авторизация — в чем разница?
• Мой поиск аналога Microsoft Visio
• Как правильно визуализировать данные
• Справочник: кавычки
• Уж послала, так послала: 10 словосочетаний-паразитов в технических текстах
• Как правильно задавать вопросы
• Некомпетентные компетенции
• Как создать внутреннюю базу знаний для большой IT-компании. Из хаоса в гиперспейсы
• Sir Markdown. Лекция Яндекса
• Как создать ТЗ для программиста
• Когда инструкцию лучше не читать
• Diátaxis: структура технической документации

Работа с текстом

• Как улучшить английский в документации
• Как улучшить английский в документации. Часть 2: ловушки двусмысленности

О профессии

• Составляем документацию разработчика пошагово без диет и тренировок

Про стандарты

• Формализованный метод разбора и анализа нормативных и методических документов, а также синтеза на их основе локальных актов
• Как присвоить документу «код по госту»
• О стандартах документации
• Документирование по ГОСТ 34* — это просто