Технический журнал о документации, статических страницах и простых рабочих процессах. Здесь собраны небольшие приёмы, которые легко повторить и проверить.
Хорошая инструкция отвечает на три вопроса: что делает инструмент, как его запустить и как проверить результат. Начните с короткого примера, затем опишите ограничения и настройки.
Храните примеры рядом с кодом и проверяйте их после изменений. Небольшая актуальная инструкция полезнее подробной, которая больше не работает.
Для небольшого журнала или справочника часто хватает HTML и CSS. Страницы можно читать без JavaScript, они быстро загружаются и требуют немного обслуживания.
Используйте смысловую разметку, понятные ссылки и удобную ширину текста. Проверьте страницу на узком экране и добавьте отдельную страницу для отсутствующих адресов.
Перед изменением запишите ожидаемое поведение. После него повторите короткую проверку и сохраните результат. Так проще заметить ошибку и вернуться к рабочему состоянию.
У каждой важной настройки должна быть причина. Комментарий о том, почему выбрано значение, помогает спустя месяц лучше, чем повтор названия параметра.