Памятка: Шаги по созданию качественного блокнота
Содержание
Памятка: Шаги по созданию качественного блокнота¶
1. Сделай план из подзаголовков¶
Как вариант - вставить краткое описание с задачами, которые надо решить.
По мере выполнения действий ячейку с пунктами плана можно разбивать с помощью Shift-Ctrl-Minus
.
Таким образом, когда вы выполнили одно действие - сразу видно, что делать дальше.
2. Если что-то лишнее - сделай File \ Make a Copy..
¶
блокноты не дружат с системами контроля версий (построчное сравнение), поэтому сложно сравнить два похожих блокнота
при внесении изменений они автоматически сохраняются, затирая исходный файл, но автосохранение очень полезно и его лучше не отключать
для работы с версиями предусмотрена система Checkpoint, но надо помнить, что и когда там сохранялось
во время работы раздумья о том, нужен этот кусок или нет, - вредны!
решение о том, может ли пригодиться впоследствии этот рисунок или идея, всегда должно быть - «да», но не в данной работе
если новая идея не пошла - можно вернуться к коду, который спокойно «висит» в соседней вкладке
вычистить ненужные файлы с похожими названиями можно потом, при чистке папке (если это понадобится)
3. После каждого рисунка отмечай, что на нем видно¶
вначале кажется, что и так все ясно, но когда возвращаешься через полгода - можно уже забыть
часто то, что делаешь для себя, потом хочешь передать другим для самостоятельного изучения - и лучше эти ценные для понимания комментарии делать сразу
4. Собери импорт библиотек в 1-2 ячейках в начале блокнота¶
так легче перемещать рабочие ячейки без утраты «выполнимости»
при знакомстве с таким блокнотом сразу понятно какие библиотеки нужны
хотя повторный импорт модуля не приводит к тратам ресурсов, дублирование одной и той же операции в одном блокноте выглядит неаккуратно
5. Когда все готово - сделай Kernel \ Restart & Run All
¶
проверка, что все работает
обновление индексов в ячейках в порядке выполнениия
можно проследить за чистой скоростью работы, возможно задуматься об оптимизации кода или подгрузке данных в локальную папку для ускорения последующих запусков