Документация к ПО, презентация. О чем писать, что показывать?

[pu4koff]

Сообщение от Человек_Борща

Как презентовать свою программу где-либо?
О чем писать в описании, что рассказать в возможностяхи особенностях?

Сильно зависит от программы. Для небольших программ достаточно написать вкратце что это за программа и кому нужна + демка. Для программ уровня предприятия таки действительно лучше вкратце описать что это и с чем едят. Я лично программы без демок даже не смотрю. Демки по мылу с указанием своих контактов заказывать не люблю.
Читать рекламные опусы о том какая это крутотень - тоже не интересно.
Во многих случаях мне многое о программе говорит её интерфейс, так что скрины окон также важно вывалить, можно даже без подробного описания что за кнопочки там есть и что делают, просто для наглядности.

Сообщение от Человек_Борща

Далее документация:
О чем писать в ней, чтобыпользователю было легко читать и понимать текст?

Я пока не встречал пользователя, который бы читал документацию по программе. Разве что это сильно что-то специфическое. Админскую и разработческую документацию я читаю и ненавижу её за "воду".
Как по мне, так лучше чётко прописать что где нужно настроить, какие порты открыть, что в фаерволе открыть, какую службу запустить, какие функции в API предусмотрены, конечно же с примерами их вызова.
Если брать пользовательскую документацию, то она тоже обычно отстойная. В неё лезут, когда сами не разобрались, а значит юзабилити хромает или функционал не покрывает всех потребностей. Сейчас уже скорее в яндекс полезут с вопросом, нежели будут rtf на диске искать (про F1 вообще сейчас уже наверно мало кто помнит). Общая отстойности в документации в том, что она не помогает решить возникшие проблемы и не описывает как выполнить задачу, она рассказывает что и как умеет программа, оперируя кнопочками и окнами, а не целями и задачами, в то время, как человеки думают именно в задачах и до кнопочек им нет никакого дела.

[Larboss]

Для программ уровня предприятия таки действительно лучше вкратце описать что это и с чем едят.

Притом, описание вкратце должно быть не единственным видом документации, идущим с программным продуктом уровня предприятия.

[pu4koff]

Сообщение от Larboss

Притом, описание вкратце должно быть не единственным видом документации, идущим с программным продуктом уровня предприятия.

То было про презентацию написано, а не про документацию. В "больших" продуктах функционала много и демку ставить пробовать будет лениво, чтобы чисто узнать что программа умеет (к тому же не всегда там всё просто ставится), тут лучше таки дать презентацию с ключевыми моментами. В мелких программах функционала раз, два и обчелся, поэтому достаточно краткого описания что вот программа для того-то и того-то и демки, на которой можно вживую посмотреть ху из ху.