РУКОВОДСТВО ПРОГРАММИСТА.
ТРЕБОВАНИЯ К СОДЕРЖАНИЮ И ОФОРМЛЕНИЮ
United system for program documentation.
Programmer’s guide. Requirements to contents and form of presentation
Постановлением Государственного комитета стандартов Совета Министров СССР от 12 января 1979 г. ¹ 74 срок введения установлен
с 01.01. 1980 г.
Настоящий стандарт устанавливает требования к содержанию и оформлению программного документа «Руководство программиста», определённого ГОСТ 19.101-77.
Стандарт полностью соответствует СТ СЭВ 2095-80.
1. ОБЩИЕ ПОЛОЖЕНИЯ
1.1. Структуру и оформление документа устанавливают в соответствии с ГОСТ 19.105-78.
Составление информационной части (аннотации и содержания) является обязательным.
1.2. Руководство программиста должно содержать следующие разделы:
- назначение и условия применения программ;
- характеристика программы;
- обращение к программе;
- входные и выходные данные;
- сообщения.
В зависимости от особенностей документы допускается объединять отдельные разделы или вводить новые.
Как отвечать на вопросы, которые ты не знаешь. Техническое интервью для программиста.
2. СОДЕРЖАНИЕ РАЗДЕЛОВ
2.1. В разделе «Назначение и условия применения программ» должны быть указаны назначение и функции, выполняемые программой, условия, необходимые для выполнения программы (объем оперативной памяти, требования к составу и параметрам периферийных устройств, требования к программного обеспечению и т.п.).
2.2. В разделе «Характеристика программы» должно быть приведено описание основных характеристик и особенностей программы (временные характеристики, режим работы, средства контроля правильности выполнения и самовосстанавливаемости программы и т.п.).
2.3. В разделе «Обращение к программе» должно быть приведено описание процедур вызова программы (способы передачи управления и параметров данных и др.).
2.4. В разделе «Входные и выходные данные» должно быть приведено описание организации используемой входной и выходной информации и, при необходимости, ее кодирования.
2.5. В разделе «Сообщения» должны быть указаны тексты сообщений, выдаваемых программисту или оператору в ходе выполнения программы, описание их содержания и действий, которые необходимо предпринять по этим сообщениям.
2.6. В приложении к руководству программиста могут быть приведены дополнительные материалы (примеры, иллюстрации, таблицы, графики и т.п.).
* Переиздание (Ноябрь 1987 г.) с Изменением № 1, утвержденным в сентябре 1981 г (ИУС 11-81)
ГОСТы
- Классификаторы ЕСКД
- Перечень стандартов
- ГОСТ 2.xxx (ЕСКД)
- ГОСТ 6.ххх (УСД)
- ГОСТ 15.ххх
- ГОСТ 19.xxx (ЕСПД)
- ГОСТ 24.xxx (ЕСС АСУ)
- ГОСТ 34.ххх
Источник: www.rugost.com
Техническая документация
разработка техдокументации по ГОСТ без бумаги и расстояний
33 — РУКОВОДСТВО ПРОГРАММИСТА по ГОСТ 19.504-79 (пример, образец)
Пример (образец) документа Руководство программиста по ГОСТ 19.504-79, взаимоувязанный разделами (подразделами, пунктами и подпунктами) с комплектом программных документов, выполненным согласно требованиям Единой системы программной документации (ЕСПД). Редакция от 01.02.2023.
Типичные задачи junior разработчика в компании | Как работают джуниоры? (мой опыт)
Настоящий документ представляет собой Руководство программиста ПК «Интероперабельность».
Документ предназначен для участников команды проекта, осуществляющих разработку ПК «Интероперабельность», а также персонала ФГУП «СпецТяжМонтажПромСтройСельхозЦифровизация», ответственного за эксплуатацию ПК «Интероперабельность» в части использования по назначению.
Документ разработан согласно ГОСТ 19.504-79, структура и оформление документа соответствуют ГОСТ 19.105-78, основные надписи титульной части — по ГОСТ 19.104-78, выполнен печатным способом согласно ГОСТ 19.106-78.
Основная часть документа содержит сведения о назначении, условиях применения, характеристиках ПК «Интероперабельность», способы обращения к ПК «Интероперабельность», сведения о входных и выходных данных, а также сообщения ПК «Интероперабельность».
1 Назначение и условия применения программы (33)
1.1 Назначение программы (33)
- автоматическое формирование запроса (ссылки), содержащего заголовок (title) текущей страницы в качестве фактического параметра;
- автоматизированная отправка запроса в онлайновые сервисы поиска;
- автоматическое формирование запроса (ссылки), содержащего адрес (URL) текущей страницы в качестве фактического параметра;
- автоматизированная отправка запроса в онлайновые сервисы анализа.
Э0101 Проблемно-ориентированные функции — автоматизация деятельности и управление, см. эталонная модель интероперабельности — определены.
- производственная среда (офис) ФГУП «СпецТяжМонтажПромСтройСельхозЦифровизация»;
- отдел маркетинга;
- отдел разработки и поисковой оптимизации веб-контента;
- отдел веб-дизайна и программирования.
- отдел маркетинга
- отдел веб-дизайна и программирования
- отдел разработки и поисковой оптимизации веб-контента
Э0103 Функции ведения и управления — см. управляющая функция — определены.
1.2 Функции, выполняемые программой (33)
Функции, выполняемые программой:
- запрос и получение позиции ссылки на текущую страницу сайта ФГУП «СпецТяжМонтажПромСтройСельхозЦифровизация» в результатах поиска Яндекс.Поиск и Google;
- запрос и получение сведений о плотности использования текста (ключевых слов контента) текущей страницы (сервис Be1.ru);
- запрос и получение результатов анализа фактической скорости загрузки и основных Интернет-показателей текущей страницы (сервис PageSpeed Insights);
- запрос и получение результатов проверки соответствия текущей страницы стандартам CSS3 + SVG и HTML (сервисы CSS Validation Service и Nu Html Checker).
Получение позиции ссылки на текущую страницу в результатах поиска информационно-поисковых систем (поисковых машин, сервисов) Яндекс.Поиск и Google требуется для выяснения причин снижения посещаемости страницы конечными пользователями.
Получение сведений о плотности использования текста (ключевых слов контента) текущей страницы с применением сервиса Be1.ru необходимо для выяснения возможных причин снижения позиции ссылки на страницу в результатах поиска из-за ухудшения присущего или присвоенного странице качества.
Получение результатов анализа фактической скорости загрузки и основных Интернет-показателей текущей страницы с применением сервиса PageSpeed Insights необходимо для для выяснения возможных причин снижения позиции ссылки на страницу в результатах поиска из-за ухудшения потребительских свойств страницы.
Получение результатов проверки соответствия текущей страницы стандартам CSS3 + SVG и HTML (XHTML, SMIL, MathMLL и т.д.) с применением сервисов CSS Validation Service и Nu Html Checker (Markup Validation Service) необходимо для выяснения возможных причин снижения позиции ссылки на страницу в результатах поиска из-за ухудшения конструктивных характеристик страницы.
1.3 Условия, необходимые для выполнения программы (33)
Необходимый состав технических средств, его основные характеристики и условия эксплуатации приведены ниже.
Клиентская часть ТС:
- IBM-совместимая ПЭВМкласса (семейства) не ниже Реntium IV с доступом в Интернет;
- мышь и (или) иное устройство ввода позиций (планшет, тачпад и т.п.) в составе периферийного оборудования.
Серверная часть ТС:
- см. System requirements;
- оперативная память от 32 Мб (и выше).
Э0303 Требуемые периферийные устройства определены.
Э0302 Требуемый объем внешней памяти определен.
Э0301 Требуемый объем внутренней памяти определен.
Рекомендованные технические характеристики ТС клиентской части:
- процессор Intel Core i7 — 9700K Socket 1151 v2 8-ядерный;
- кулер DeepCool GAMMA ARCHER BIGPRO;
- материнская плата Gigabyte Z390 AORUS PRO Socket 1151 v2;
- оперативная память 64 Gb DDR4 2400 MHz Crucial Ballistix Sport LT White (4×16 Gb KIT);
- видеокарта nVidia GeForce GTX1050 Ti ASUS PCI-E 4096 Mb (PH-GTX1050TI-4G);
- твердотельный накопитель 240 Gb SSD Western Digital 2.5″;
- блок питания 500 W Aerocool VX-500 PLUS;
- Wi-Fi адаптер ASUS PCE-N10 Wi-Fi адаптер.
Условия эксплуатации — соответствующие условиям эксплуатации IBM-совместимых ПЭВМ класса не ниже Реntium IV.
По стойкости к воздействию внешних климатических факторов в процессе эксплуатации IBM-совместимые ПЭВМ относят к средствам вычислительной техники (СВТ) 1-3-й групп [из 1.3.1 ГОСТ 21552-84].
Нормальными климатическими условиями эксплуатации СВТ 1-3-й групп являются: температура окружающего воздуха (20 ± 5) °С, относительная влажность (60 ± 15) %, атмосферное давление от 84 до 107 кПа (от 630 до 800 мм рт. ст.) [из 1.3.2 ГОСТ 21552-84].
Источник: tdocs.su
Руководство программиста
Руководство пользователя составляют на основании ГОСТ 19.504-79. Руководство программиста разрабатывают в трех случаях:
– программный продукт по своему основному назначению является средой разработки или библиотекой (как Delphi или Qt);
– комплекс или программный продукт служит платформой для разработки программ или систем определенного типа (как 1С или Axapta);
– программа распространяется вместе с исходным кодом или постоянно модифицируется самими разработчиками.
Очевидная задача руководства программиста — снабдить разработчика информацией, которой ему будет достаточно для создания на базе разработанного программного продукта собственных программ или систем.
Руководство программиста должно объяснять:
– С какими объектами программист имеет дело, где они находятся, сколько времени существуют и как они взаимодействуют между собой. Какие из них он создает сам, а какие предоставлены ему изначально средой, фреймворком, библиотекой.
– Какие еще средства разработки (кроме разработанного программного продукта) необходимы для того, чтобы создать приложение или систему. Например, если разработанный программный продукт — библиотека, программисту потребуются компилятор, какая-то среда разработки и прочий инструментарий.
– В какой среде функционирует приложение или система. Какими будут его минимальные требования к системе. Понадобятся ли для его запуска какие-либо дополнительные программные средства: фреймворки, рантаймы, интерпретаторы.
– Что представляет собой минимальное работоспособное приложение или минимальная работоспособная система. Какие объекты и в какой последовательности необходимо создать, как соединить их друг с другом, чтобы приложение осуществило какой-то свой минимальный вывод.
– Как (по шагам) скомпилировать работоспособное приложение или развернуть работоспособную систему.
Кроме того руководство программиста должно содержать полные описания всех предусмотренных в программном продукте объектов. Если это функции, то должны быть приведены их синопсисы, если классы, то описания их интерфейсов и т. Д.
Если программный продукт предполагает использование оригинального языка программирования и снабжен собственным компилятором или интерпретатором, в руководство программиста необходимо включить его описание.
В тексте руководства обязательно должны быть соблюдены следующие правила:
– При вводе нового понятия следует опираться только на те понятия, которые были введены ранее или заведомо знакомы читателю.
– Ввод каждого понятия должен быть чем-то обоснован.
Основное требование при описании отдельных объектов — полнота описания каждого из них.
При описании объектов особое внимание следует уделять следующим аспектам:
– Что обязательно должно предшествовать созданию и использованию объекта.
– Каковы побочные эффекты обращения к объекту.
– Особенности интерпретации объектом передаваемых ему данных.
– Где «физически» (в каком файле, в какой библиотеке) находится объект.
– Желательно по каждому объекту привести примеры использования, небольшие фрагменты кода, демонстрирующие создание объекта (если перед использованием его необходимо создать), передачу объекту входных данных, получение выходных данных и их интерпретацию.
Возможно выполнение руководства программиста гипертекстовым.
Структура руководства программиста:
1. Назначение и условия применения программы.
2. Характеристика программы.
3. Обращение к программе.
4. Входные и выходные данные.
Руководство программиста может комплектоваться различными схемами, например, схемами базы данных, диаграммами классов, графами вызова
Система «e-port дилер» предназначена для приема и проведения моментальных платежей при оплате услуг мобильной связи, доступа в Интернет и т. П. Центральный сервер системы принадлежит группе e-port, а пункт приема платежей может открыть любой желающий, установив у себя на компьютере (подключенном к Интернету) программу-клиент. Обмен данными между центральным сервером и программой-клиентом осуществляется по специальному протоколу. Протокол открытый, что позволяет различным организациям: банкам, розничным сетям, сетям платежных терминалов, осуществлять платежи непосредственно из собственных систем. Протокол разработан Группой e-port, а техническая документация «Философтом»по ее заказу.
Система e-port дилер: клиент-серверный протокол. Назначение и обзор возможностей
Основные преимущества использования протокола
1 Реализация протокола (шлюз)
1.1 Общие сведения
1.2 Структура приложения
2. Как работает шлюз
2.1 Регистрация и отчетность
2.2 Обмен данными с сервером
2.2.1 Структура пакета
2.2.3 Порядок обмена пакетами
2.3 Цикл обработки операции
2.3.. Запрос операции
2.3.3 Анализ ответа сервера
2.3.4 Нестандартные ситуации
3 Спецификация протокола
3.1 Структурные элементы пакета
3.4 Пополнение счета
3.5 Покупка PIN-кода
3.6 Прерывание процесса обработки операции
3.7 Транзакционные свойства операции
3.8 Запрос на проведение нескольких операций
3.11 Статус операции
3.11.1 Примеры сообщений о статусе операций
3.11.2 Коды состояния находящихся в обработке или завершенных операций
3.11 Уведомления системы
Приложение 1. DTD XML-запроса и комментарий
Приложение А DTD XML-ответа
Приложение Б. Правила расчета суммовых полей
Приложение В Примеры запросов и ответов сервера
Понравилась статья? Добавь ее в закладку (CTRL+D) и не забудь поделиться с друзьями:
Источник: studopedia.ru