Любая человеческая деятельность, любой проект порождает информацию. Ей нужно делиться, но не всей. Желательно обработать поток данных, прежде чем предоставить его кому-то. На этом принципе построено любое обучение, вербальное и даже невербальное взаимодействие — тот, кто отправляет информацию, учитывает возможности и особенности того, кто её принимает. Читать далее
Дисклеймер: это продолжение темы о составлении правильной технической документации. В первой статье мы рассказали, какие цели преследуются при составлении инфраструктурной документации и какие у нее особенности. А теперь поговорим о том, как составить годный стайлгайд, чтобы
Команда, разрабатывающая софт для создания пользовательской документации, делится лайфхаками на тему написания идеальной пользовательской документации для тех, кто далёк от написания руководств к программе. Читать далее
Люди читают пользовательскую документацию, когда самостоятельно не могут с чем-то разобраться. Они не делают это для развлечения. И эмоции, которые преобладают в этот момент, далеко не всегда позитивные. Как разработчик пользовательской документации может помочь пользователю? Что ему необходимо учитывать при написании документа? Читать дальше →