В авиации существует международный стандарт ASD-STE100. Он определяет, как писать техническую документацию.
Не что писать, а именно как.
Стандарт запрещает использовать большинство слов английского языка. Вместо десятков тысяч слов автору оставляют словарь примерно из девятисот. Каждое слово имеет только одно разрешенное значение. Никаких синонимов “для красоты”. Короткие предложения. Один глагол - одно действие. Если инструкцию можно понять двояко, значит она написана неправильно.
Со стороны это выглядит странно.
Но документация стала понятнее. Ее стало легче переводить и обслуживать. Количество ошибок при работе с техникой уменьшилось.
Самый надежный способ повысить качество - не искать более умных людей, а уменьшить количество мест, где можно напортачить.
Потому что инструкция существует не для того, чтобы показать, какой автор умный.
Она существует, чтобы другой человек не ошибся.
И это работает везде.
Хороший процесс - это набор ограничений. Хороший интерфейс - набор ограничений (помните этот пост?). Хорошая архитектура тоже набор ограничений.
Плохая система требует талантливых людей.
Хорошая позволяет обычным людям стабильно делать все правильно.
#всякое
Не что писать, а именно как.
Стандарт запрещает использовать большинство слов английского языка. Вместо десятков тысяч слов автору оставляют словарь примерно из девятисот. Каждое слово имеет только одно разрешенное значение. Никаких синонимов “для красоты”. Короткие предложения. Один глагол - одно действие. Если инструкцию можно понять двояко, значит она написана неправильно.
Со стороны это выглядит странно.
Но документация стала понятнее. Ее стало легче переводить и обслуживать. Количество ошибок при работе с техникой уменьшилось.
Самый надежный способ повысить качество - не искать более умных людей, а уменьшить количество мест, где можно напортачить.
Потому что инструкция существует не для того, чтобы показать, какой автор умный.
Она существует, чтобы другой человек не ошибся.
И это работает везде.
Хороший процесс - это набор ограничений. Хороший интерфейс - набор ограничений (помните этот пост?). Хорошая архитектура тоже набор ограничений.
Плохая система требует талантливых людей.
Хорошая позволяет обычным людям стабильно делать все правильно.
#всякое