Общая информация
Документация принадлежит к типу программной и эксплуатационной. Объединяет в себе пакеты документов о формальном языке. Создается для пользователей языка – программистов, операторов, верстальщиков, кодеров. Целью данной документации является предоставление пользователям языка для решения задач, описанных на формальном языке. Все документы соответствуют стандартам: ГОСТ 19.504-79.
Предмет и назначение
Группа формальных языков объединяет в себе все языки: программирования, управления задачами, описания строения данных и т.д. Все языки разительно отличаются друг от друга, но объединяет их то, что все они – искусственные, состоят из конкретного набора элементов и подчинены обязательным грамматическим правилам.
Поскольку изучить язык можно только с помощью описания, оно и должно предоставить пользователю возможность получить полное представление о данном формальном языке и предоставить возможность его применения.
Содержание
Описание языка должно включать следующую информацию:
1. Цель и область применения.
2. Вид и тип текста, составленного на данном языке – программы, макросы и т.д.
3. Свод синтаксических правила: виды элементов текста и возможные их взаимодействия.
4. Логические действия в обработке документов, которые разные в разных языках.
5. Определенные элементы языка и их взаимосвязь с синтаксическими конструкциями.
6. Вписанные блоки функционирования.
Также описание может включать:
- советы по использованию стиля программирования;
- возможные типовые ошибки, способы их нахождения и исправления;
- способы оптимизации для обеспечения быстродействия;
- список предлагаемых трансляторов (парсеров, фреймворков).
Методология и язык написания
Основное назначение описания любого языка – объяснить читателю его главное предназначение. Оно должно быть самостоятельным, т.к. читатели могут просто не знать никакого даже из самых употребляемых языков. Значит краткое описание понятия самого цикла необходимо. Описание любого элемента иллюстрируется примером.
Стандартная структура - согласно ГОСТ 19.506-79.
1. Общие сведения.
2. Элементы языка.
3. Способы структурирования программы.
4. Средства обмена данными.
5. Встроенные элементы.
6. Средства отладки.
