Администрирование Создание документации и отчетов
| Создание документации и отчетов |
|
С нашей точки зрения, одним из самых утомительных и наименее желательных аспектов работы системного администратора является сбор различной информации и составление документации для пользователей. Эта работа может нести прямую выгоду вашим пользователям, которые будут читать документацию, или, возможно, косвенную выгоду пользователям, потому что вы или человек, пришедший вам на замену, сможете обратиться к ней при необходимости внести изменения в будущем. В любом случае создание документации является критически важным аспектом вашей деятельности. Но если это не та работа, выполнением которой вам хотелось бы заняться, тогда вы, скорее всего, отложите ее. Выполнить эту работу вам поможет Python. Нет, Python не напишет за вас документацию, но он поможет собрать, отформатировать и отправить документацию заинтересованным лицам. В этом разделе мы сосредоточим все свое внимание на следующих темах: сбор, форматирование и передача информации о написанных вами программах. Любая информация, которой вы предполагаете поделиться, где-то существует: она может находиться в файлах журналов, у вас в голове, она может быть доступна в виде результатов выполнения некоторых команд, она может даже находиться где-нибудь в базе данных. Самое первое, что необходимо сделать, это собрать необходимую информацию. Следующий шаг на пути к передаче информации другим людям заключается в том, чтобы оформить собранную информацию. Для оформления можно использовать такие форматы, как PDF, PNG, JPG, HTML или даже обычный текст. Наконец, необходимо передать эту информацию людям, которые заинтересованы в ней. Надо понять, каким образом заинтересованным лицам будет удобнее получать требуемую информацию: по электронной почте, на веб-сайте или просматривая файлы на совместно используемом диске.
Related Articles
Set as favorite
Bookmark
Email This
Hits: 167 Комментарии (0)RSS feed CommentsНаписать комментарий |
