[docs] как принято указывать ссылки

Kirill Maslinsky =?iso-8859-1?q?kirill_=CE=C1_altlinux=2Eorg?=
Вт Май 27 13:42:40 MSD 2008


On Tue, May 27, 2008 at 04:12:30PM +0700, Mikhail Gusarov wrote:
> Twas brillig at 13:08:23 27.05.2008 UTC+04 when Kirill Maslinsky did gyre and gimble:
> 
>  KM> Каких-то нормативных рекомендаций относительно этого вопроса мне встречать
>  KM> не приходилось.
> 
> http://tools.ietf.org/html/rfc1738 пункт 3.1 - слэш является частью синтаксиса
> URLа, отсутствие его - это просто сокращение, которые понимают все вменяемые
> клиенты.

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

Решая, ставить ли в документации слэш или нет, нужно учитывать, 
кто адресат текста и какой будет носитель, а также как текст будет использоваться.
Документация вообще адресована человеку, а он парсит URL не по
формальному синтаксису, а по-человечески, на что оказывает большое
влияние опыт работы с клиентами. 

Если речь о печатной документации, то ссылка может только 
перенабираться руками из текста, и тут чем короче она будет, 
тем лучше и для набирающего, и для верстки. 

Если речь идёт об электронной документации, то есть большой смысл 
оформлять ссылки на URL в виде гиперссылок, а не плоского текста, 
так что их будут не копировать, а кликать по ним. Так что текст 
ссылки опять же адресован человеку, а не машине, и тут читабельность
важнее стандарта. 

Так что я за написание без "/" в текстах документации.

Понятно, что желательно, чтобы значение href при этом соответствовало
стандарту, и там конечный слэш уместен и никому не мешает.

-- 
С уважением,
Кирилл Маслинский
Альт Линукс
руководитель издательских проектов


Подробная информация о списке рассылки docs