Технический писатель. Шаблоны 7 основных документов. Бери и применяй
Если нужна Заказчику документация по ГОСТ 34, то существует 7 основных документа:
- ТЗ — Техническое задание.
- ПЗ — Пояснительная записка или Описание системы.
- СР — Схема развертывания системы.
- API — Описание протокола взаимодействия с внешними системами.
- РА— Руководство системного администратора.
- РП — Руководство пользователя.
- ПМИ — Программа и методика испытаний.
В шаблонах документов есть реальная обезличенная информация как пример заполнения, нужно ее отредактировать, либо заменить информацией по нужной системе.
Python . Первая программа .
Python - простой и лаконичный язык программирования с понятным синтаксисом.
Программы состоят из множества строк с командами на Python, которые выполняются последовательно.
Дзен Питона — это рекомендации, как сделать ваш код красивым и понятным:
- Красивое лучше, чем уродливое.
- Явное лучше, чем неявное.
- Простое лучше, чем сложное.
- Сложное лучше, чем запутанное.
- Плоское лучше, чем вложенное.
- Разреженное лучше, чем плотное.
- Читаемость имеет значение.
- Особые случаи не настолько особые, чтобы нарушать правила.
- При этом практичность важнее безупречности.
- Ошибка никогда не должна замалчиваться.
- Если только вы сами этого не захотите.
- Встретив двусмысленность, отбрось искушение угадать.
- Должен существовать один и, желательно, только один очевидный способ сделать что-то.
- Хотя он поначалу может быть и не очевиден, если вы не голландец.
- Сейчас лучше, чем никогда.
- Хотя никогда зачастую лучше, чем прямо сейчас.
- Если реализацию сложно объяснить — идея плоха.
- Если реализацию легко объяснить — идея, возможно, хороша.
- Пространства имён — отличная штука! Будем делать их больше!
Программирование - процесс написания команд и их выполнения компьютером.
Запустим Python и напишем следующую строку
print (“hello word”)
после запуска получим результат
hello word
УРА! Первая программа готова.
Для этой программы использовался метод (команда) print(), которая выводит данные на консоль.
Функция — это подпрограмма, выполняющая определённые действия. Функция print() — это встроенная в Python подпрограмма для вывода данных на экран (или для «печати на экране», на жаргоне программистов). Функция print() выводит на экран любые данные, указанные в скобках после названия функции. Программисты называют такие данные «аргументы». Говорят, что аргумент передаётся в функцию, а функция их принимает. Строки, начинающиеся с символа # — это комментарии, примечания, которые автор программы пишет для других разработчиков.
Термины. Разное .
API (англ. Application Programming Interface — программный интерфейс приложения) — это набор способов и правил, по которым различные программы взаимодействуют между собой и обмениваются данными. На русском его называют интерфейсом программирования приложения (в противоположность пользовательскому интерфейсу, используемому для взаимодействия конечного пользователя с программой). Все эти взаимодействия происходят с помощью функций, классов, методов, структур, а иногда констант одной программы, к которой обращаются другие. Это основной принцип работы API. API обеспечивает взаимодействие между двумя системами.
Пример из обычной жизни, вы покупаете билет в кино с помощью банковской карты. Во время покупки терминал обращается к API банка, который выпустил вашу карту, и отправляет запрос на оплату. А если вы заказываете такси через приложение, оно обращается к платёжной системе тоже через API.
API обычно входит в описание какого-либо интернет-протокола (например, SCIM), программного каркаса (фреймворка) или стандарта вызовов функций операционной системы. Часто реализуется отдельной программной библиотекой или сервисом операционной системы.
Документация API содержит информацию о том, как разработчики должны структурировать эти запросы и ответы.