Наше внутреннее программное обеспечение использовалось для многих пользователей, и отдел обучения спросил нас о каких-либо советах относительно формата документации для конечного пользователя.
Кто-нибудь знает, где я могу найти хорошие примеры документации для конечного пользователя программного обеспечения, которую учебный отдел может использовать для вдохновения, или какие-либо полезные сайты?
Это похоже на этот вопрос, однако я ищу документацию для конечного пользователя, используемую нетехническими пользователями.
design
documentation
users
Джон
источник
источник
Ответы:
Возможно, вы захотите начать с опроса своих внутренних пользователей о программном обеспечении и выяснить, какую информацию они хотели бы узнать.
Большая часть документации, которую я написал о программном обеспечении, имела в виду одну или несколько аудиторий. Ваш учебный отдел, вероятно, выиграет от скелета тем (например, TOC). Тогда вы можете обсудить, какие темы актуальны, а какие не имеют отношения к их целям обучения.
Некоторые темы могут охватывать:
Постарайтесь предвидеть, как ваши конечные пользователи используют ваше программное обеспечение, основываясь на ваших знаниях о его разработке, ваших знаниях о том, что оно делает, а также на основе (надеюсь) ваших интервью с конечными пользователями.
Самое главное, попробуйте сделать документацию, которую вы хотели бы прочитать, используйте забавные примеры примеров для демонстрации и используйте множество аннотированных снимков экрана.
Надеюсь это поможет
источник
Я прочитал несколько «Руководств для конечных пользователей» и написал одно, и я думаю, что есть много элементов, которые повышают их эффективность:
Я надеюсь, что это может быть полезно для вас.
источник
Вы упоминаете, что он будет использоваться для обучения.
Если вы ищете учебный документ, а не справочный документ, мой любимый такой сайт - учебное пособие Джоэла Спольски по Mercurial здесь .
Если бы ваш учебный документ был наполовину таким же крутым, как урок Джоэла по Mercurial, я бы его прочитал. Но вам нужен кто-то с а) страстью к письму и б) невероятной глубиной знаний, чтобы справиться с этим, даже если бы вы могли скопировать 3 пункта выше. Надеюсь, что это работает.
источник
Я не знаю, подходит ли это к вашим потребностям, но существуют системы, используемые для технической документации sphinx , которые приходят на ум и облегчают создание онлайн-документации. Может ли что-то подобное использоваться для того, что вас интересует?
Я также натолкнулся на ReadTheDocs, который делает то же самое, но является размещенным решением.
источник
Проверьте Общество Технической Связи (STC) . Многие из их победителей написали продукцию, которая обычно доступна. Они также могут иметь образцы в наличии. Став членом, вы также получите доступ к большему объему информации.
источник