Самый эффективный способ — не создавать её вообще. Как известно, самая плохая документация лучше, чем никакой.Но кто-то может возразить, что если у вашего продукта нет никакой документации, то нельзя сказать, что вы создали худшую. И формально будет прав. Так что давайте разберемся, как сделать худшую.Статья будет полезна всем, кто может испортить документацию: техническим писателям, аналитикам, владельцам продуктов, менеджерам, тимлидам. Читать далее
Недавно я решил перечитать рассказ «В исправительной колонии» Франца Кафки. Впервые я познакомился с ним еще студентом — задолго до того, как узнал о существовании профессии технического писателя.Теперь я смотрел на него совсем иначе — глазами, которые видели тысячи страниц руководств, справочников и API-документации.И в какой-то момент мне в голову пришла довольно абсурдная мысль: я читаю не просто рассказ Кафки — я читаю почти готовую техническую документацию. Читать далее
C вами Семён Факторович и компания documentat.io. С 2018 года мы помогаем IT-компаниям создавать техническую документацию: пишем документацию на заказ, консультируем инженерные команды по процессам документирования, учим техписателей и инженеров писать документацию.В январе 2024 года мы…
C вами Семён Факторович и компания documentat.io. С 2018 года мы помогаем IT-компаниям создавать техническую документацию: пишем документацию на заказ, консультируем инженерные команды по процессам документирования, учим техписателей и инженеров писать документацию.В январе 2024 года мы…