IT и Написание документированных процедур.

Аватара пользователя

Автор темы
texadmin
Администратор
Сообщения: 4217
Стаж: 7 лет 8 месяцев
Поблагодарили: 577 раз
Пол:

IT и Написание документированных процедур.

Непрочитанное сообщение texadmin »

Язык программирования Python завоевал популярность у более прогрессивных собратьев (я бы сказал успешно отвоевал).
Причина была проста за основу была взята концепция максимального дружелюбия к пользователю (из wikipedia - ориентированный на повышение производительности разработчика и читаемости кода)
С большой долей вероятности в ближайшее время мы все массово ринемся переписывать документированные процедуры. И возможно философия языка сделает последующую работу немного легче:
Текст философии:
  • Красивое лучше, чем уродливое.
  • Явное лучше, чем неявное.
  • Простое лучше, чем сложное.
  • Сложное лучше, чем запутанное.
  • Плоское лучше, чем вложенное. комментарии для лабораторий - не стоит в действии описывать другое действие
  • Разреженное лучше, чем плотное. комментарии для лабораторий - не валить всё в кучу
  • Читаемость имеет значение.
  • Особые случаи не настолько особые, чтобы нарушать правила.
  • При этом практичность важнее безупречности.
  • Ошибки никогда не должны замалчиваться.
  • Если не замалчиваются явно.
  • Встретив двусмысленность, отбрось искушение угадать.
  • Должен существовать один — и, желательно, только один — очевидный способ сделать это.
  • Хотя он поначалу может быть и не очевиден, если вы не голландец. комментарии для лабораторий - не нашёл что эта поговорка обозначает. Вероятно что решение может быть настолько очевидным что мы просто игнорируем его (не догадываемся)
  • Сейчас лучше, чем никогда.
  • Хотя никогда зачастую лучше, чем прямо сейчас.
  • Если реализацию сложно объяснить — идея плоха.
  • Если реализацию легко объяснить — идея, возможно, хороша.
  • Пространства имён — отличная вещь! Давайте будем делать их больше! комментарии для лабораторий - выделяйте больше отдельных логических действий (как то так)
:оригинальный текст
Аватара пользователя

cordek
Партнёр форума
Сообщения: 2489
Стаж: 7 лет 5 месяцев
Поблагодарили: 725 раз

IT и Написание документированных процедур.

Непрочитанное сообщение cordek »

Идея хорошая, примерно такого принципа я придерживался при переписывании СМК. Кроме некоторых положений, применимы по моему только к коду. Например плоское лучше чем вложенное или сейчас лучше чем никогда.
Добавлю что при построении СМК я использовал следующий постулат :
Руководство по качеству для экспертов, процедуры для людей.
Таким образом все нужные для работы пункты вынесены в процедуры и людям нет необходимости пролистать руководство по качеству.

Отправлено спустя 4 минуты:
Ещё из It
Меняя часть, проверяй целиком. Когда меняют какую-то часть кода, надо проводить тестирование всего кода, вдруг где-то вылезет ошибка.
Я в СМК не вношу отдельные изменения в документы, а заменяю их целиком. Это позволяет уменьшить ошибки.
Валидация ПО для лабораторий.
email:cordek @ yandex .ru
https://t.me/limsaccreditation
https://dzen.ru/limsaccreditation
Аватара пользователя

Автор темы
texadmin
Администратор
Сообщения: 4217
Стаж: 7 лет 8 месяцев
Поблагодарили: 577 раз
Пол:

IT и Написание документированных процедур.

Непрочитанное сообщение texadmin »

Не захотел писать свои мысли в очерке (делать полноценную статью) но придётся дополнить.
Идея заключалась в следующем, при составлении каких либо процедур следует для себя уяснить -как я это делаю, и для чего. Подобный подход привёл безнадёжный проект (ещё один язык программирования) к успеху.
Как я например пишу:
1. Я стараюсь писать так, чтобы было понятно старшекласснику.
2. Не боюсь показаться глупым.
Когда статья или документ написан использую:
3. https://text.ru/ проверяю текст на воду, не обязательно исправлять помеченное, просто позволяет взглянуть на текст по иному. (вероятно есть ограничение на количество и длину проверки)
водность.jpg
4. Яндекс Спеллер (с длинными текстами плохо справляет, у меня находит ошибки с которыми не справляется редактор, может я как то по особому ошибаюсь). Этот сервис встроен в форум [стандартный ответ] => [абв].
орфографические ошибки.jpg
5. Даю прочитать текст двум людям, тому кто в курсе о чём речь, и тому кто не в курсе, например жене. (мой главный вопрос -понятно про что написал?), с этим тестом всё плохо в первом случае человеку лень читать, во втором человек пытаться исправляться грамматические и лексические ошибки. А если Вы поняли задача была иная. Был ещё на работе у нас филолог, но уволился (жаль).
Это не руководство к действию, каждый может для себя что-то придумать.
Аватара пользователя

cordek
Партнёр форума
Сообщения: 2489
Стаж: 7 лет 5 месяцев
Поблагодарили: 725 раз

IT и Написание документированных процедур.

Непрочитанное сообщение cordek »

Ещё на одной учёбе нам сказали хорошую мысль:
Если пишешь СМК, пиши сам.
Здесь проявляется отличие смк от IT, поскольку в программировании сейчас считается нормальным надергать кусков кода с разных проектов, особенно в Питоне, поэтому он такой популярный.
К сожалению у менеджера по качеству нет компилятора, в котором можно проверить работоспособность смк, поэтому следует избегать безумного копирования.
Валидация ПО для лабораторий.
email:cordek @ yandex .ru
https://t.me/limsaccreditation
https://dzen.ru/limsaccreditation

Вернуться в «Статьи»