Маркетинговая документация
Для многих приложений необходимо располагать рядом рекламные материалы, с тем чтобы заинтересовать людей, обратив их внимание на продукт. Такая форма документации имеет целью:
подогреть интерес к продукту у потенциальных пользователей
информировать их о том, что именно делает продукт, с тем чтобы их ожидания совпадали с тем, что они получат
объяснить положение продукта по сравнению с конкурирующими решениями
Одна из хороших маркетинговых практик — предоставление слогана — простой запоминающейся фразы, иллюстрирующей то, что мы хотим донести до пользователя, а также характеризующей ощущение, которое создаёт продукт.
Часто бывает так, что коробка продукта и другие маркетинговые материалы дают более ясную картину о возможностях и способах использования программы, чем всё остальное.
Техническая документация
Техническая документация — набор документов, используемых при проектировании (конструировании), создании (изготовлении) и использовании (эксплуатации) каких-либо технических объектов: зданий, сооружений, промышленных товаров, программного и аппаратного обеспечения.
Техническую документацию разделяют на несколько видов:
конструкторская документация
эксплуатационная документация
ремонтная документация
технологическая документация
документы, определяющие технологический цикл изделия
документы, дающие информацию, необходимую для организации производства и ремонта изделия
Техническая документация по другому называется: Паспорта, руководства, техническая литература
Стандарты
Единая система конструкторской документации (ЕСКД)
Единая система технологической документации (ЕСТД)
Единая система программной документации (ЕСПД)
Требования к содержанию и оформлению отдельных программных документов Спецификация
Спецификация является основным программным документом для компонентов, применяемых самостоятельно, и для комплексов.
Форма спецификации приведена на рисунке ниже:
Спецификация в общем случае должна содержать разделы:
документация;
комплексы;
компоненты.
Аннотацию и содержание можно не включать в документ.
Наименование каждого раздела указывают в виде заголовка в графе "Наименование", заголовок подчеркивают. Далее записывают заимствованные программные документы. в порядке возрастания кодов организаций - разработчиков и далее в порядке возрастания кода вида документа.
После каждого раздела спецификации необходимо оставлять несколько свободных строк для дополнительных записей.
Графы спецификаций заполняют следующим образом:
в графе "Обозначение":
в разделе "Документация" - обозначения записываемых документов программы;
в разделе "Комплексы" - обозначения спецификаций комплексов, входящих в данный комплекс;
в разделе "Компоненты" - обозначения основных программных документов компонентов;
в графе "Наименование":
в разделе "Документация" - наименование и вид документа для документов на данную программу; полное наименование программы, наименование и вид документа для заимствованных документов;
в разделах "Комплексы" и "Компоненты" - полное наименование программы, наименование и вид документа;
в графе "Примечание" - дополнительные сведения, относящиеся к записанным в спецификации программам.
При отсутствии места в графе "Примечание" допускается записывать только порядковые номера примечаний, а текст примечаний - в конце соответствующих разделов спецификации. Можно текст примечаний записывать на последних листах спецификации без граф с проставлением порядкового номера примечания.
В графе "Обозначение" запись производят в одну строку. В остальных графах спецификации записи допускаются в несколько строк.