📧Статья является компиляцией писем, поэтому написана в эпистолярном стиле.
Привет!
По нашему недавнему разговору об информативных ссылках на задачи.
Что такое «информативные ссылки»?
Как ты знаешь, нашим центральным информационным ресурсом является багтрекер по адресу https://redmine.company.ru. Ты, я и другие разработчики постоянно кидаем друг другу ссылки на задачи из этого багтрекера.
Под информативными я подразумеваю ссылки, оформленные как Bug #122363: Переписать скрипт восстановления контента, в противовес безликому https://redmine.company.ru/issues/122363. Думаю, не нужно объяснять, почему первый вариант лучше. Хотя нет, давай всё-таки объясню.
Чего мы достигаем, передавая коллегам ссылки в информативном виде?
Мы точнее обозначаем тему и облегчаем поиск наших сообщений.
💡 Наше сообщение с информативной ссылкой (пример выше) легко найти по словам «скрипт» и «восстановление». А по «122363» искать никто не будет, кто-ж их упомнит, эти циферки…
Мы повышаем в коллективе уровень информационной культуры.
💡 Коллега, получивший от нас сообщение с информативной ссылкой, увидит, что мы не швырнули ему ссылку, как гнилую кость, а, напротив, позаботились, чтобы он воспринял контекст наиболее точно. Наш коллега — человек вежливый, поэтому в благодарность он старательнее, чем обычно, сделает свою часть работы.
Мы информируем весь коллектив о том, какой темой сейчас занимаемся.
💡 Ссылки на задачи часто передаются широковещательно, в групповых чатах. Допустим, мы упомянули нашу задачу https://redmine.company.ru/issues/122363 в таком чате. А теперь представим, что сотрудник Вася работал со «скриптами восстановления контента» буквально пару дней назад, и, конечно, будет рад помочь нам парой толковых советов. Правда, есть нюанс… Мы ведь не удосужились написать ссылку информативно, так что Вася вряд ли узнает, что за безликим «122363» прячется знакомая ему тема. Станет ли он открывать эту ссылку? Маловероятно, ведь сообщение не адресовано лично ему.
Мы задаём единообразие и стимулируем писать качественные заголовки задач.
💡 Как только передача информативных ссылок становится в коллективе общепринятой практикой, коллеги начинают обращать больше внимания на корректность и точность написания заголовков задач. А качественные заголовки задач — важный вклад в повышение качества.
В общем, ЛЕТАЙТЕ САМОЛЁТАМИ «АЭРОФЛОТА»! Ой, о чём это я… Ах да.
Как писать информативные ссылки?
На дворе уже довольно густой 21-й век, поэтому большинство текстовых систем и чатов так или иначе поддерживают гипертекст. Одним из распространённых форматов является Markdown: популярные чаты Slack и Mattermost используют именно его.
Интернет-ссылка в Markdown размечается как [текст ссылки](https://…). То есть информативная ссылка на нашу задачу в формате Markdown имеет вид: [Bug #122363: Переписать скрипт восстановления контента](https://redmine.company.ru/issues/122363).
Ура! Теперь мы можем создавать информативные ссылки на задачи парой ловких движений мыши и нажатием пары кнопок. Но, опять же, есть нюанс.
Расширения браузера для создания информативных ссылок
Вот ты возражаешь:
В день я пишу сотни сообщений, и в половине из них — ссылки на задачи. Ты, конечно, неплохо раскидал за «информационную культуру» и прочее светлое будущее, но, если я буду каждый раз корячиться с этим… down-Mark’ом, я выгорю ещё до обеда. Так что извини, Лёша, придётся мне и дальше рассылать ссылки на задачи, как ты выражаешься, «обезличенными», иначе у меня работа встанет.
Что-ж, аргументы дельные, нельзя не согласиться. А давай представим, что есть инструменты, позволяющие сгенерировать информативную ссылку простым нажатием комбинации клавиш, без необходимости каждый раз выделять мышкой текст и форматировать Markdown вручную.
Да что там представлять, они просто есть! Не одних нас заботит эта проблема. Итак…
Microsoft Edge
Функция генерации информативной ссылки на текущую страницу реализована штатно и не требует установки расширений. Чтобы сгенерировать в буфере (clipboard) информативную ссылку:
- Открываем браузером страницу задачи.
- Переводим курсор на адресную строку: Alt+D.
- Делаем «Copy»: Ctrl+C (Ctrl+Insert).
- В целевой программе делаем «Paste»: Ctrl+V (Shift+Insert). Cсылка вставится как информативная.
Есть пара значимых аспектов:
- Да, нужно открыть страницу, ссылку на которую мы собираемся отправить. Простой тычок правой кнопкой мышки поверх ссылки в тексте скопирует её как обезличенную:
https://…. - Шаг 1 является обязательным и для всех рецептов, приведённых ниже. Сразу после копирования ссылки страницу можно закрыть. Я обычно так и делаю.
- Edge формирует ссылку именно как гипертекст. Поэтому её можно вставить, например, в электронное письмо или офисный документ. В рецептах для других браузеров это не так, там ссылка форматируется как фрагмент Markdown-содержимого.
Google Chrome
Ставим расширение Link-Md для Chrome. Оно простое, не требует конфигурации, сразу имеет привязанную горячую клавишу. Чтобы сгенерировать в буфере информативную ссылку:
- Открываем браузером страницу задачи.
- Нажимаем Alt+Ctrl+C.
- В целевой программе делаем «Paste». Вставится фрагмент Markdown-текста.
Есть также и чуть более старое расширение Create Link, которое тоже работает, но требует более кропотливой настройки.
Mozilla Firefox
Ставим расширение Link-Md для Firefox. Чтобы сгенерировать в буфере информативную ссылку:
- Открываем браузером страницу задачи.
- Нажимаем Alt+Ctrl+C.
- В целевой программе делаем «Paste». Вставится фрагмент Markdown-текста.
Для Firefox много расширений, которые находятся по словам «create markdown link». Думаю, некоторые из них тоже работают.
Что в итоге?
Я думаю, стоит потратить пять минут на установку расширения для твоего браузера и освоить за день сочетание клавиш для нового действия. Тогда у тебя появится выбор — посылать товарищу ссылку информативно или как безликий URL.
Все знакомые мне разумные люди останавливались на первом варианте. 😊
Будь здоров!