Котенко А. А. : другие произведения.

Документирование программного обеспечения. В помощь техническому писателю

Самиздат: [Регистрация] [Найти] [Рейтинги] [Обсуждения] [Новинки] [Обзоры] [Помощь|Техвопросы]
Ссылки:
 Ваша оценка:
  • Аннотация:
    В учебном пособии рассказывается о важности процесса документирования, его месте в процессе создания программного средства и о работе технического писателя. Рассмотрены различные виды программной документации и существующие российские и международные стандарты, знание которых необходимо техническому писателю. В заключение приводится краткое описание современных издательских систем и CASE-средств, используемых для создания документации различного уровня. Книга предназначена для студентов направления "Прикладная математика и информатика" (ФГОС 3-го поколения), а также для разработчиков программных средств.

КУПИТЬ ТУТ!

  Учебное пособие является подробной реферативной подборкой материалов, так или иначе связанных с процессом документирования программного средства. Дело в том, что информация по данному вопросу рассредоточена по огромному числу источников, и до сих пор не было издано ни одного пособия для технического писателя.
  
  Все вопросы программной инженерии, проектирования и организации работы над сложнымии программными средствами освещены во второй части пособия "Проектирование программных средств".
  
  Данная книга не является руководством пользователя по той или иной программе, в ней описывается только процесс документирования, его основные этапы. В первой части рассказывается о процессе документирования и его месте в работе IТ-подразделения, о работе технического писателя. Во второй части подробно рассматриваются различные виды программной документации и существующие российские и международные стандарты, знание которых необходимо техническому писателю. В третьей части приводится описание различных современных издательских систем, используемых для создания документации различного уровня. Учебное пособие является навигатором в области документирования программ и позволит читателю найти все требуемые документы, обозначить содержание того или иного документа, выбрать издательскую систему для дальнейшей работы с документацией.
  
  В тексте приведены примеры оглавлений некоторых документов, их краткое содержание и т.д.
  
  Очевидно, что рассматриваемые в данном пособии принципы документирования программного средства никогда не будут реализованы: описывается идеальная и самая сложная ситуация. Если руководствоваться абсолютно всеми данными, приведенными в учебном пособии, при создании достаточно простой программы, можно оказаться попросту погребенным под кипой никому не нужных руководств и документации. Следование абсолютно всем рекомендациям учебного пособия приемлемо для создания крупномасштабных проектов. В остальных случаях рекомендуется в первую очередь руководствоваться правилами здравого смысла и создавать только те документы, в которых есть необходимость.
   Но главная идея документирования заключается в постулате: "Программы пишутся для людей, а не для себя любимого!"
 Ваша оценка:
Связаться с программистом сайта.

Новые книги авторов СИ, вышедшие из печати:
О.Болдырева "Крадуш. Чужие души" М.Николаев "Вторжение на Землю"

Как попасть в этoт список
Сайт - "Художники" .. || .. Доска об'явлений "Книги"