Пояснительная записка
Как правило, Пояснительная записка бывает самым сложным документом на ПО, подчас вызывая множество споров и дискуссий вокруг своего содержания. Почему так случается?
Назначение пояснительной записки
Мы уже говорили о том, что в разработке программного обеспечения Технический проект – это один из важных этапов создания технической документации. В нем должно быть представлено описание вашей системы с учетом выбранных технологий, как от нас того требует ГОСТ 34. А документ Пояснительная записка к техническому проекту, или, сокращенно, ПЗ, является одним из основных документов данного этапа. И, надо сказать, чаще всего именно Пояснительная записка бывает самым сложным документом на ПО, подчас вызывая множество споров и дискуссий вокруг своего содержания.
Состав типовой пояснительной записки
Пояснительная записка к техническому проекту включает в себя такие разделы, как:
- Введение. В этом разделе приводится полное наименование системы и тема разработки, а также список документов, послуживших основанием для работ по проекту.
- Назначение и область применения. Здесь описываются цели и задачи, которые будут решены с помощью системы, а также сфера ее использования.
- Технические характеристики. Этот раздел обычно разбивают на подразделы, в которых описывают: постановку задачи на создание программы; используемый математический аппарат; алгоритм работы ПО; структуру входных и выходных данных; состав технических и программных средств. Также необходимо приводить расчеты и результаты анализа для обоснования выбора именно тех решений, о которых говорится в документе.
- Ожидаемые технико-экономические показатели. Раздел предполагает экономическое обоснование разработки с учетом ее технических показателей.р- Источники, использованные при разработке. Раздел представляет собой список документов, статей и публикаций, на которые были приведены ссылки в тексте.
Стандарты для пояснительной записки
Состав разделов определяется ГОСТ 19.404, однако, стандарт позволяет эти разделы при необходимости объединять, а также добавлять новые. В случае использования ГОСТ серии 34 следует разрабатывать документ в соответствии с РД 50-34.698. Тем не менее, документ должен оставаться в рамках требований общих стандартов, таких, например, как ГОСТ 19.105.
Заключение
Как же с наименьшими затратами создать документ на программу, максимально полезный для вашего проекта, который:
- с одной стороны, внятно и доходчиво представляет все нужные (а порой и нудные) сведения, включая сложные технические подробности;
- с другой стороны, отвечает многочисленным требованиям государственных стандартов как к содержанию, так и к оформлению?
В большинстве случаев наилучшим решением оказывается – поручить написание Пояснительной записки к техническому проекту профессионалам с большим опытом создания подобных документов, особенно учитывая тот факт, что данную услугу сейчас можно получить по вполне доступной цене.
Вас также может заинтересовать: