Технический писатель. Схема развертывания системы.
СР — Схема развертывания системы
Документ для Системного администратора Заказчика, по нему администратор легко и быстро развернет Систему на своих серверах (это большие и мощные компьютеры).
Шаблон СP пока нет, если у кого есть поделитесь пжл.
Python . Style Guide(рекомендации) по написанию кода.
Единый стиль оформления делает код понятным для самого программиста и его коллег с разным уровнем подготовки. В идеале наиболее сложный фрагмент кода должен быть понятен с первого прочтения. Это упрощает командную разработку и обучение новичков, позволяет вам быстро возвращаться к собственным давним проектам.
18 правил написания кода на Python:
1. На каждый уровень отступа используйте по 4 пробела.
2. Длину строки рекомендуется ограничить 79 символами.
3. Функции верхнего уровня и определения классов отделяются двумя пустыми строками. Определения методов внутри класса разделяются одной пустой строкой. Дополнительные пустые строки используются для логического разделения.
4. Для каждого импорта - отдельная строка. Порядок расположения - стандартные библиотеки, сторонние библиотеки, локальные модули приложения. Импорты всегда помещаются в начале файла, сразу после комментариев к модулю и строк документации, и перед объявлением констант.
5. Избегайте лишних пробелов внутри круглых, квадратных или фигурных скобок.
6. Используйте одиночный пробел с каждой стороны у операторы присваивания =, +=, -=, операторов сравнения ==, <, >, !=, <>, <=, >=, in, not in, is, is not и логических операторов and, or, not. Не используйте пробелы вокруг знака =, если он используется для обозначения именованного аргумента или значения параметров по умолчанию.
7. Комментарии, которые противоречат коду, хуже, чем их отсутствие. Всегда исправляйте комментарии при обновлении кода.
8. Никогда не используйте символы l (маленькая латинская буква «L»), O (заглавная латинская буква «o») или I(заглавная латинская буква «i») в качестве имен.
9. Модули должны иметь короткие имена, состоящие из маленьких букв.
10. Имена классов должны обычно следовать соглашению CapitalizedWords (слова с заглавными буквами).
11. Имена функций должны состоять из маленьких букв, а слова разделяться символами подчеркивания (lower_case_with_underscores).
12. Для имен методов и переменных экземпляров классов используйте тот же стиль, что и для имен функций.
13. Всегда используйте self в качестве первого аргумента метода экземпляра объекта. Всегда используйте cls в качестве первого аргумента метода класса.
14. Сравнения с None должны обязательно выполняться с использованием операторов is или is not, а не с помощью операторов сравнения.
15. Наследуйте свой класс исключения от Exception. Перехватывайте конкретные ошибки вместо простого выражения except.
16. Всегда используйте выражение def, а не присваивание лямбда-выражения к имени.
17. Постарайтесь заключать в каждую конструкцию try...except минимум кода, чтобы легче отлавливать ошибки.
18. Для последовательностей (строк, списков, кортежей) используйте тот факт, что пустая последовательность есть false.
Термины. Разное .
Интерпретатор - это слой программной логики между вашим программным кодом и аппаратурой вашего компьютера.
Интерпретатор -программа, которая выполняет код, написанный на языке программирования. Она не переводит его в машинные коды целиком, а построчно принимает команды и сразу выполняет их