Документация к продукту. Как упорядочить этот хаос.
Мы часто сталкиваемся с отсутствием документации к продукту, программе или если она и есть, но настолько непонятная и не полная, что читать ее бесполезно. Сегодня я постараюсь описать процесс создания вменяемой документации на созданный вами программный продукт. Документации для пользователя и для программистов, зацепим все аспекты. Букв будет много, тема большая. Для написания документации на продукт можно обратиться к стандартам, где на сегодня есть два типа: ГОСТы — это нечто, что разрабатывалось при Советском Союзе, их слишком много...
384 читали · 3 года назад
Как написать руководство пользователя к программному обеспечению или WEB-сервису: советы, приемы, инструменты
Всем доброго времени суток, кто решил прочитать статью, посвященную документации пользователя. Заголовок говорит сам за себя. Здесь вы найдете как общие, так и довольно специфические советы по созданию руководства пользователя. Надеюсь, они будут вам полезны! Приятного чтения. Если перед вами стоит вопрос – нужно ли вашему продукту пользовательское руководство, то отвечу сразу – да, нужно. Почему? На это есть две причины: 1. Качественная документация повышает лояльность клиента и ценность продукта в целом...