Программное обеспечение, используемое на предприятии
ПО для разработки сопроводительной документации
MarkdownPad 2
Markdown [13] - облегченный язык разметки, созданный для удобства написания и чтения текстов. Он позволяет набирать текст, не используя HTML. Сам преобразует набранное, и делает это без мусора в коде.
Это мощный инструмент для копирайтеров, веб-разработчиков и контент-менеджеров. С его помощью можно быстро и красиво оформлять текст. Синтаксис встроен в Ghost, Trello, Slack, Хабр и еще множество сервисов.
Рисунок 3.1.1.1 – Окно MarkdownPad 2
Редактор поддерживает подсветку синтаксиса, проверку синтаксиса одного языка (в том числе русского), экспорт в форматы HTML, PDF (только в платной версии). Иными словами, MarkdownPad 2, как и другие специальный редакторы, является хорошим выбором для технического писателя. В тех же случаях, когда пользователю предстоит редактировать файлы различного формата, можно адаптировать свой редактор и для редактирования текстов с markdown-разметкой.
Программа используется компанией «7Топ» для составления описания создаваемого продукта, иногда ТЗ.
ПО для разработки программного продукта
Visual Studio Code
Visual Studio Code - это среда разработки от компании Microsoft, созданная совсем недавно с использованием технологий вроде Node.js. В отличие от полного пакета Visual Studio, эта среда представляет собой текстовый редактор с возможностью подключения огромного количества плагинов. Она предназначена для разработки на различных языках программирования и для разных платформ. Поддерживаются не только Windows, но и Linux, а также MacOS [14].
|
|
|
Интерфейс программы типичен для многих редакторов кода. Но есть и свои особенности. Условно главное окно программы можно разделить на семь частей (рисунок 3.2.1.1):
Рисунок 3.2.1.1 – Интерфейс Visual Studio Code
– Главное меню программы - можно использовать для доступа к настройкам, открытия проектов и папок и многого другого;
– Левая панель - эта панель есть только в VS Code, она позволяет переключаться между просмотром дерева каталогов, поиском, отладкой и окном установки дополнений. Сюда же некоторые расширения добавляют свои меню, например Docker, Git и расширение для управления проектами.
– Проводник - по умолчанию здесь отображается дерево каталогов, но тут же вы обнаружите настройки отладки или доступные для установки расширения, если выбран соответствующий пункт на боковой панели.
– Рабочая область - здесь выполняется редактирование файла.
– Мини карта - позволяет быстро ориентироваться по открытому исходнику.
– Нижняя панель - здесь отображается вывод программы при выполнении, консоль самой Visual Code, а также здесь есть встроенный терминал.
|
|
|
– Статус бар - отображается общая информация о состоянии программы.
Редактор покрывает потребности компании «7Топ». В частности, компания использует редактор для написания программ с использованием языков PHP, CSS, HTML, JavaScript, фреймворков React Native, Yii2 и др.
Требования по оформлению программной документации
ЕСПД
Правила оформления [12]:
Каждый отдельный программный документ оформляется по (общим для всех документов ЕСПД) требованиям ГОСТ 19.101-77, ГОСТ 19.103-77, ГОСТ 19.104-78*, ГОСТ 19.105-78*, ГОСТ 19.106-78*, ГОСТ 19.604-78* и ГОСТа для конкретного программного документа.
Например: для Руководства оператора - ГОСТ 19.505-79. ЕСПД. Руководство оператора. Требования к содержанию и оформлению.
4.1.1 ГОСТ 19.105-78* (Общие требования к программным документам)
Из данного ГОСТа мы получаем общие требования к оформлению программных документов. Ниже приведены наиболее важные разделы.
– Настоящий стандарт устанавливает общие требования к оформлению программных документов для вычислительных машин, комплексов и систем, независимо от их назначения и области применения и предусмотренных стандартами Единой системы программной документации (ЕСПД) для любого способа выполнения документов на различных носителях данных.
|
|
|
– Программный документ состоит из следующих условных частей:
o титульной;
o информационной;
o основной;
o регистрации изменений.
– Титульная часть состоит из листа утверждения и титульного листа. Правила оформления листа утверждения и титульного листа устанавливаются по ГОСТ 19.104-78.
– Информационная часть должна состоять из аннотации и содержания.
o Необходимость включения информационной части в различные виды программных документов установлена соответствующими стандартами ЕСПД на эти документы.
o В аннотации приводят сведения о назначении документа и краткое изложение его основной части.
o Содержание включает перечень записей о структурных элементах основной части документа, в каждую из которых входят:
§ обозначение структурного элемента (номер раздела, подраздела и т.д.);
§ наименование структурного элемента;
§ адрес структурного элемента на носителе данных (например, номер страницы, номер файла и т.п.).
– Состав и структура основной части программного документа устанавливаются стандартами ЕСПД на соответствующие документы.
– Часть регистрации изменений (должна присуствовать в каждом программном документе)
o О каждом изменении программного документа в этой части делается запись в соответствии с требованиями ГОСТ 19.603-78.
Дата добавления: 2021-07-19; просмотров: 266; Мы поможем в написании вашей работы! |
Мы поможем в написании ваших работ!