Ходит птичка весело по тропинке бедствий, не предвидя от сего никаких последствий.
(Найдите оригинал, прочтите, предложите лучшее название, близкое оригиналу, потом будете минусовать — пп).
Я недавно пришел к выводу, что я был неосторожным, озорным инженером. Я заслуживаю серьезного наказания, потому что я пренебрегал своим журналом для заметок.
Это моя вина. Нет никого, кого бы я мог обвинить, я виноват сам. От меня требовали вести журнал во время обучения в университете (у нас он назывался «Журнал прохождения производственной практики» -пп). Позже, когда я приступил к своей первой работе в качестве члена команды проектирования центральных процессоров (CPU) для ЭВМ, мой наставник — Дэйв Поттс, — разъяснял мне преимущества занесения в свой журнал мельчайших деталей.
Я был хорошим мальчиком в течение многих лет, используя журнал, чтобы фиксировать свои мысли и инженерные решения (в том числе отражая как те варианты, которые приняты, так и те, которые были отвергнуты). Мои журналы изобиловали рисованными от руки схемами и механическими диаграммами, вперемешку с описаниями экспериментов и таблицами результатов. В меня было вколочено понимание необходимости отслеживания ситуаций, когда что-либо получается не так, как я ожидал и твердая убежденность в обязательности фиксировать неожиданные либо необъяснимые результаты (не бывает необъяснимых результатов, бывают необъясненные -пп). Идея заключалась в том, что вы никогда не знаете заранее, будет ли что-либо, что кажется несущественным в настоящий момент, необычайно важным когда-либо в будущем, и что понимание причин своих неудач не менее значительно, чем фиксация своих успехов.
Однако, на протяжении многих лет, по мере того, как я начинал все больше писать и говорить о инженерном деле, нежели непосредственно заниматься разработкой, — я начал пренебрегать моим журналом и потерял привычку записывать. Я повесил голову от стыда.
Совсем недавно, мое отсутствие привычки к ведению судового журнала, в процессе работы над хобби проектами, такими, как Vetinari Clock, мой BADASS Display, и моя Возлюбленная Машина Предсказаний (Inamorata Prognostication Engine) вернулось ко мне бумерангом, чтобы уязвить меня.
«Почему я в конечном итоге поставил это конкретный номинал и тип конденсатора?» — спрашиваю я себя. Был ли его выбор основан на продуманном и мотивированном решении, или же это был просто оказались ближайшее значение, которое я смог найти в то время. (Грустно признаться, но мы никогда не будем знать ответ на эту головоломку). «Ведь был же интернет-ресурса, который содержал всю полезную информацию о расчете даты следующей полной и синей луны», бормочу я себе. И так далее. (Иногда ситуация напоминает сцену из известного фильма — «А это что за доработка? Кто ее сделал? Я сделал? А, ну да, я сделал.»-пп).
Как раз в прошлые выходные, я вспоминал мелочи, связанные с 5V регулятором питания, который неплох по эффективности. Я хотел бы приобрести еще пару для новых проектов, но откуда я получил этот блок? Было ли это Allied Electronics или Digi-Key или Mouser или Newark или ...(лет десять назад мне было намного проще — Митино, а теперь тоже есть варианты -пп)? И каков был каталожный номер этого маленького устройства? Если бы я только записал все эти вещи в моем журнале (если бы только у меня был журнал, в котором я мог бы их записать).
Результатом стало то, что я забежал в местный магазин во время обеда, чтобы купить новый журнал. Отныне я буду жить в сопровождении моего журнала, и я запишу в него все, что должно быть записано.
Вам все еще указывают на необходимость использование журнала в университете? Я, конечно, надеюсь, что это так. На самом деле, я только что нашел это видео доктора Дональда Эглера, профессора машиностроения в Университете штата Айдахо, который объясняет свои рекомендации и модель использования журнала (смотрите оригинал, там ссылка -пп).
Как насчет Вас? Вы всегда шли по торной дороге судового журнала, или вы поддались соблазну лени, как Ваш покорный слуга? Не бойтесь, потому что даже если вы забрели в буераки, у Вас еще есть надежда — купить новый журнал при первой возможности и перейти на светлую сторону силы.
Комментарии (24)
Cobolorum
19.05.2015 17:29Если вы не может ЭТО нарисовать или записать — значит этого нет в природе и нет даже в ваших мыслях.
AndreyDmitriev
19.05.2015 21:18+2Всегда и всё записываю, уже почти двадцать лет (без фанатизма, но тем не менее — ключевые моменты — когда что зарелизилось, митинги, идеи, и т.д.). Много раз помогало, а иногда и спасало. За это время выработал нехитрую систему меток и оглавлений, так что минимальный поиск по записям работает. Хороший блокнот и приличная авторучка — что может быть лучше?
Jabher
19.05.2015 21:32-1Для железа — да, возможно, что-то делается просто потому что это эффективнее всего.
С программированием все куда интереснее. Если ваш код при прочтении вызывает вопросы — это либо плохой код, либо грязные хаки (то есть борьба с плохим кодом другого программиста / железом). Первое надо исправлять, второе — документировать.
Если программист начинает делать журнал записей, чтобы не забыть, почему он делает то или иное (не документацию к внешним интерфейсам, а именно журнал того, как он делает) — он делает что-то не так.
Вот вам дзен питона про это:
Явное лучше, чем неявное.
Простое лучше, чем сложное.
…
Должен существовать один — и, желательно, только один — очевидный способ сделать это.
…
Если реализацию сложно объяснить — идея плоха.
Если реализацию легко объяснить — идея, возможно, хороша.
vedenin1980
19.05.2015 22:13+2Если программист начинает делать журнал записей, чтобы не забыть, почему он делает то или иное (не документацию к внешним интерфейсам, а именно журнал того, как он делает) — он делает что-то не так.
Вообще-то системы контроля версий и тикетов (например, jira и git) это и есть этот самый журнал, если они используются правильно. По идее, должны быть задокументированы все изменения сделанные в команде, иначе потом концов не найдешь.
P.S. Что насчет перевода, какой-то он странный, как будто гуглом переводчиком перевели, а потом самые крупные косяки поправили и выложили.Jabher
19.05.2015 22:16+1Вот тут — не спорю. Но они служат больше для того, чтобы обозначать группы изменений как смену целостного состояния — мы все знаем, что по-хорошему каждый коммит должен работать, и при «археологических раскопках» важно понимать, что те или иные группы изменений были связаны.
alff31
19.05.2015 22:53+1Тут шире вопрос стоит. В оригинале есть видео объясняющее.
Возможно у задачи существовало 5 совершенно разных решений, вы выбрали одно из них, в журнале описать почему. Либо в проекте использовали какую-либо библиотеку, чем обосновывался выбор и почему не подошли другие.
Сомневаюсь что в документации и самом коде это будет.
Ну или два дня потратили на выбор фотоаппарата, сравнивая характеристики и отзывы. Тоже можно кратко описать суть. Чтобы через год не пришлось заново мучительно вспоминать почему был сделан то или иной выбор.
HallEffect
19.05.2015 23:23+1Когда я работал инженером дата-центра, у нас был самописный сайт с БД, который так и назывался «Дневник». Ничего особо — просто поле ввода и кнопка отправить, при нажатии на которую автоматически к сообщению добавлялось имя отправителя и дата. Естественно был реализован поиск. Записывали все: когда какой клиент приходил, почему сервер не подключили, когда была аномалия в трафике, куда положили жесткие диски, когда обслуживали кондиционер и тд. Это нас выручало не раз. Когда перешел в другую компанию, подобного решения очень не хватало
vedenin1980
20.05.2015 09:11+1Когда перешел в другую компанию, подобного решения очень не хватало
По моему, даже расшаренный в гугл доке документ мог сыграть роль такой «базы». Тут вопрос скорее организационный.
gotch
20.05.2015 10:11+1Отчасти испытываю такие же чувства, как автор оригинальной статьи. Дело испортили квадратные бумажки, на которых записывается что-то ценное перед походом, например, в серверную. Потом информация вносится в заявку/запрос на изменение (в лучшем случае), а бумажка выбрасывается. Когда вместо бумажек был блокнот, было как-то удобнее. Особый интерес вызывали записи трехлетней данности — «ух ты, так вот куда мы его подкючили!». :)
progchip666
20.05.2015 11:59+1«Почему я в конечном итоге поставил это конкретный номинал и тип конденсатора?»
В последнее время я, чтобы избежать подобных проблем, использую систему контроля версий. В которой отлично хранятся не только файлы программы, но и бинарные файлы схем и трассировки. После каждого более-менее серьёзного изменения делаю апдейт и сопровождаю его комментариями. В результате можно с лёгкостью не только вспомнить что и зачем ты сделал, но и когда сделал. А главное вернуться назад в любой момент при необходимости в случае если попал в тупиковую ветку.
Это намного удобнее и никакой макулатуры!piva
20.05.2015 13:37Кстати, слышал аналогичную историю от авторов исследовательского проекта. Они писали его вместе и обновляли на github.
Теперь подумываю и сам попробовать :)progchip666
20.05.2015 14:42Очень полезно, особенно когда работаешь над проектом командой. Не раз были неприятности когда вдруг в последний момент в библиотеку попадал непостижимым образом компонент с неправильным паттерном, а в результате приходилось колдовать над платой с паяльником и скальпелем. После того, как начал использовать TortoiseHg всё это в прошлом. Сегодня слава богу популярные системы версий обзавелись графическими оболочками и стали доступны для понимания даже домохозяйкам, после некоторого интенсива конечно.
progchip666
20.05.2015 12:02-1(Найдите оригинал, прочтите, предложите лучшее название, близкое оригиналу, потом будете минусовать — пп).
Хорошим тоном в случае публикации перевода, является размещение ссылки на оригинал, а не отсылка читателей в неизвестном направлении. Чтобы тебя уважали, следует уважать своих читателей, даже если критикуешь их.vedenin1980
20.05.2015 12:13+2В хабаре всегда в переводах есть ссылка на оригинал между оценкой статьи и именем автора, вот такого вида: «Clive Maxfield».
P.S. Открыл оригинал, нажал перевести в гугл. транслейте и получил этот текст с минимальными изменениями со всеми нелепицами в переводе на русский вроде: судового журнала, я повесил голову от стыда и т.п. Неужели это так тяжело переписать полстраницы текста нормальным русским разговорным языком?progchip666
20.05.2015 14:36Сорри. Был не в курсе. Впрочем наверно не я один. Но я предпочитаю дублировать её на более видном месте в самой статье.
piva
20.05.2015 13:35+1Спасибо за перевод и как раз очень кстати. я начал вести свой журнал (или дневник — как хотите, так и называйте) после того, как начал работу за границей. Мне тогда мой шеф принёс такой журнал и рассказал о том, что на основе этих записей можно отстаивать своё авторство идеи в суде (позже я прочитал, что Чарльз Таунс так же записал себе в журнал и свою идею по созданию мазера, возможно ему в суде и пригодилось).
С тех пор у меня всё важное записано. Скопилось уже 6 или 7 таких журналов, перевозить сложно, а выбросить нельзя. Вот вчера писал отчёт и пытался вспомнить номер оптического волокна (в каталоге производителя) для которого я делал расчёты год назад. Журнал и помог, так как в нем было всё. Попутно нашел формулу и ссылку на источник, которые обещал найти для другого человека несколько дней назад.
Так что всем инженерам, исследователям и учёным советую пользоваться таким журналом.
Нужно еще сказать, что есть электронная версия в виде файла на компьютере. Но она дополняется медленно. Не знаю почему она не так привлекательна для меня как простой бумажный вариант.
Alexeyslav
Корявенько конечно… «судовой журнал» это вообще в какую тему?
Никогда не вел подобных журналов, особенно к очевидным вещам. С другой стороны, если бы и вёл — это надо как-то дополнительно систематизировать, иначе они станут абсолютно бесполезными когда в той горе бумаг невозможно будет найти что-то конкретное. Или когда не знаешь что конкретно искать и единственный способ — это перечитать все записи. А если их читать… то это запросто можно залипнуть на N часов а то и дней.
GarryC Автор
А как раз на эту тему видео в оригинальной статье.
Там первые страницы отводятся под оглавление.