Да, все равно придется отлавливать. И если документацию обновляет один человек и он в состоянии запомнить, что где должно быть, то в этом нет проблемы. Но если одну и ту же документацию обновляют разные технические писатели, и вместе они работают с большим количеством документов, то возможны ситуации, когда ссылка сломалась, а технический писатель не знает или не помнит, куда она должна вести.
Согласна с комментариями к изображениям с пунктом 4.7.2 и с таблицей 9. С комментарием про выделение служебных слов или названий — скорее, нет. В основном тексте названия у нас выделяются жирным, путаницы не происходит. Мы не выделяем отдельные слова курсивом в заголовке по редакционной политике. На мой взгляд, это избыточно.
Спасибо за обратную связь. Было интересно услышать мнение со стороны и дополнить свое представление о том, как должно быть. Про перекрестные ссылки: физически, конечно, их получается, указывать. Скорее в некоторых случаях, когда можно обойтись без них, стараемся обойтись. При внесении изменений в документацию они могут слетать, а при большом количестве ссылок одну такую сломанную можно не заметить и не обновить.
Да, все равно придется отлавливать. И если документацию обновляет один человек и он в состоянии запомнить, что где должно быть, то в этом нет проблемы. Но если одну и ту же документацию обновляют разные технические писатели, и вместе они работают с большим количеством документов, то возможны ситуации, когда ссылка сломалась, а технический писатель не знает или не помнит, куда она должна вести.
Согласна с комментариями к изображениям с пунктом 4.7.2 и с таблицей 9. С комментарием про выделение служебных слов или названий — скорее, нет. В основном тексте названия у нас выделяются жирным, путаницы не происходит. Мы не выделяем отдельные слова курсивом в заголовке по редакционной политике. На мой взгляд, это избыточно.
Спасибо за обратную связь. Было интересно услышать мнение со стороны и дополнить свое представление о том, как должно быть. Про перекрестные ссылки: физически, конечно, их получается, указывать. Скорее в некоторых случаях, когда можно обойтись без них, стараемся обойтись. При внесении изменений в документацию они могут слетать, а при большом количестве ссылок одну такую сломанную можно не заметить и не обновить.