1
0
Правильное оформление ссылки для баг-репорта
Stephany Templeton энэ хуудсыг 4 долоо хоног өмнө засварлав

Используйте непосредственный адрес на тикет в баг-трекере, например, Jira. Гиперссылку необходимо создавать якорный текст на номер баг-репорта – ISSUE-5678. Не используйте описательных фраз вроде «здесь ссылка» или «кликните сюда». Текст ссылки должен быть читаемым для систем и однозначно идентифицируемым.

Используйте особые менеджеры цитирования (Zotero, Mendeley) на стадии подбора литературы. Это уберет механические ошибки и позволит сберечь много рутинной работы. Записывайте всю информацию немедленно, библиографический список гост в момент изучения материала, чтобы впоследствии не искать несохраненные данные.

При наличии 2-х или 3-х авторов перечислите всех, через запятые, перед последним поставьте «и». Для четырех и более авторов укажите первого с пометкой «et al.».

Правила оформления даты выпуска и редакции Для ссылки на выпуск укажите дату публикации в формате: ДД.ММ.ГГГГ. Применяйте арабские цифры, через точку. Пример: 12.03.2024.

При ссылках на журнальные статьи: укажите фамилии авторов , название издания, год выхода, номер тома, диапазон страниц. В случае нормативных документов: укажите наименование акта, дату его принятия , регистрационный номер и официальный источник публикации ( к примеру, «Официальный интернет-портал правовой информации»). При ссылках на патенты: зафиксируйте номер патента , страну патентования , имя изобретателя и патентодержателя .

Старайтесь не применять references на ресурсы, находящиеся в закрытом доступе или удаленные страницы . Когда citation на такой источник необходима, сделайте снимок экрана (скриншот) страницы и приложите ее к финальной версии вашего текста .

Загрузите адресу в приватном режиме браузера, чтобы исключить влияние кэша и авторизации. Удостоверьтесь в правах доступа: пользователь без привилегий должна иметь доступ к задаче. Используйте инструменты сокращения URL (Bitly, TinyURL) для длинных адресов и убедитесь в их работоспособности их. Реализуйте автоматическую проверку ссылок в тестовой документации с помощью скриптов.

Устаревшие адреса появляются после перемещения или удаления отчёта. Включите в процесс исправления дефекта шаг по сохранению его описания.

Важно привести дату, когда вы посетили страницу. Это делается в круглых скобках после адреса: URL: https://.. (посещение: 12.05.2024). Свежесть информации – ключевой критерий.

Затем указываются выходные данные: место издания, название издательства и год. Название города пишется сокращённо по установленным правилам (например, «М.» вместо Москва), кроме городов, которые не имеют общепринятых сокращений.

Избегайте повторного полного описания библиографических сведений публикации в основном содержании работы. Всю требующуюся информацию (автор, название, дата, адрес) пользователь найдет в списке привлеченных материалов под соответствующим порядковым номером.