В настоящее время мы ищем способы помочь непрограммирующимся членам группы sysadmin познакомиться со скриптами Python, используемыми для повседневных задач sysadmin.
У кого-нибудь есть какие-либо предлагаемые инструменты документирования или лучшие практики, которые мы могли бы найти полезными для этой цели?
Изменить по адресу комментарий С.Лотта:
Во-первых, мои извинения за то, что я был слишком кратким по моему первоначальному вопросу. Моя основная цель - убедиться, что кто-то, даже не программист, может легко устранить неполадки в моих сценариях, если я не нахожусь в тот день или ухожу из организации.
То, что я ищу, - это практики, используемые другими людьми, которые играют роль «кодировщика сценариев» в технической группе, такой как команда сисадмина. Например, прежде чем я начну процесс написания сценария задачи, у меня появилась привычка сначала писать статью в нашей общей вики, объясняющую каждый шаг в деталях. Затем я основываю свои Python-скрипты на статье, используя ее как псевдокод.
Другие примеры того, что я ищу:
Использование таких инструментов, как Sphinx, для предоставления легкодоступного документа
Проведение групповых обсуждений для просмотра кода перед вводом в эксплуатацию
Разрешение членам группы сначала пройти процесс вручную (обычно мы идем по этому пути, но, возможно, нам следует сделать это более распространенной практикой)
Или столь же ценные, если не более, негативы, такие как:
Обнаружено, что интенсивное комментирование - пустая трата времени, потому что логический поток все еще чужд непрограммистам
Склонность к использованию pexpect из-за потери многословия при использовании модулей высокого уровня
Выше приведены лишь примеры вещей, о которых я думал. Надеюсь, что это проясняет вопрос! Как всегда, спасибо ТАК.