Улучшения, показаны 45 из 45.
Программа берет настройки из нестандартных переменных окружения. Их не угадать без чтения кода.
README — это лицо проекта. От его вида и содержания сразу же складывается первое впечатление, …
При чтении документации пользователя интересует как установить программу и как её запустить. Разобраться в документации …
При чтении документации пользователя прежде всего интересует как установить программу.
Никто не будет использовать ваш код, если вы не расскажете, что он делает. Поэтому в …
Программа берет настройки из нестандартных переменных окружения. Их не угадать без чтения кода.
README — это лицо проекта. От его вида и содержания сразу же складывается первое впечатление, …
При чтении документации пользователя прежде всего интересует как установить программу.
Когда в документации один текст, тратится много времени на прочтение, чтобы узнать, например, как установить …
Документация — тоже часть кода. За ней тоже стоит следить и ухаживать.
Если программа требует данных в особом формате, то пользователю надо их взять откуда-то или подготовить …
Чем больше информации в документе, тем сложнее его понять. Бывает, что в документе всё на …
В README не хватает ссылки на демонстрационную версию сайта. Развёртывание публичной версии сайта было частью …
Если ссылка в документе есть, но кликнуть по ней нельзя, то придется выделить и скопировать …
В Markdown разметке легко ошибиться — поставьте один лишний символ \` и вы сломаете форматирование …
Названия переменных, код и консольные команды внутри документации принято оформлять особым образом — как вставки …
Подсветка синтаксиса заметно облегчает чтение кода. Сразу становится видно где вызвана функция, где начинается цикл …
Точка в конце предложения обозначает конец одной мысли и начало следующей. Это элемент форматирования текста, …
Ваш заказчик хотел, чтобы сайт был доступен оффлайн. В репозитории есть код, какие-то файлы, но …
В Markdown есть два формата для вставок кода. Первый — это inlines. Его применяют для …
Разметку Markdown любят за её выразительность и простоту. В сравнении с HTML здесь не надо …
В тексте и список, и абзацы решают одну задачу - задают структуру текста, разбивая его …
Знаки препинания в конце заголовка могут быть признаком плохого тона, а иногда даже признаком неграмотности. …
Заголовки -- это особый элемент форматирования текста. Он предназначен для выделения главной мысли в абзаце, …
Локальные настройки проекта не должны попасть в общий репозиторий. Самый простой и надёжный способ этого …
Ссылки можно оформлять множеством разных способов. Но когда вы встраиваете ссылки в текст, важно оформлять …
Инструкции в документации неполны либо содержат ошибки. Возможно, инструкции просто устарели со временем. Воспринимайте инструкции …
Заголовки -- это особый элемент форматирования текста. Он предназначен для выделения главной мысли в абзаце, …
Документация — тоже часть кода. За ней тоже стоит следить и ухаживать.
Если в ссылке нет ошибок, то она будет вести на нужную страницу или откроется заданная …
Если программа требует данных в особом формате, то пользователю надо их взять откуда-то или подготовить …
Чтобы многострочный код и списки лучше читались, их тоже нужно специальным образом оформить. Без Markdown …
Со временем в дополнение к одному API может понадобиться подключение еще нескольких. У них каждого …
Чем больше информации в документе, тем сложнее его понять. Бывает, что в документе всё на …
Программа не может авторизоваться на Девмане по токену. Вместо токена она требует в настройках строку …
В вашем README есть пример заполнения файла с конфигами. Дело в том, что так их …
Библиотека livereload предоставляет два интерфейса. Есть обычная библиотека, её можно импортировать и вызвать одну из …
Когда другой программист захочет развернуть проект, то первым делом он пойдёт искать переменные окружения в …
Скриптовые утилиты часто приходится использовать из консоли. Лезть в readme, ради того чтобы вспомнить, что …
Во время написания документации стоит избегать терминов из прогаммирования, чтобы текст читался как можно проще. …
Любой текст можно "убить" перегруженными предложениями. Читатель читает слева направо, а не из конца предложения …
Очень часто для наглядности хочется показать в README изображения (скриншоты или gif) и возникает вопрос: …
Написание кода всегда сопровождается составлением документации, хотя бы в минимальном виде. Плохое форматирование мешает читать …
В папке `static/` должна лежать **только статика**. Не стоит складывать туда всё подряд, от каких-то …
