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