Редактирование: Проект:Технические работы/Шаблоны/Документирование (раздел)

=== Структура документации ===
* Раздел «Назначение» в документации избыточен — со слов о том, для чего нужен шаблон, документация и так начинается. Раздел «Использование» должен быть посвящен тому, ''как'' использовать, а не ''зачем''.
* Оглавление, если документация не занимает очень много места, выводите справа при помощи шаблона {{Tl|TOC right}} или удаляйте при помощи слова {{Mwmw|NOTOC}} (например, в самом начале документации).
* Оформляйте список перенаправлений на шаблон (шорткатов) при помощи шаблона {{Tl|днш}}, размещая его под описанием предназначения шаблона или внизу.
* Раздел «TemplateData», или «Параметры шаблона для визуального редактора», помещайте вниз, под разделом «См. также» (см. [[РуСказки:Форум/Архив/Технический/2016/03#TemplateData в документациях шаблонов|вопрос на форуме]]). На странице документации его всё равно никто не читает, если есть вручную свёрстанная документация.
* Для нескольких шаблонов из одного «семейства» (группы близких по внешнему виду или связанных по смыслу шаблонов) можно давать общую документацию (например, документации семейства шаблонов {{Tl|Lang|text=lang-''x''}} и группы шаблонов {{Tl|столбцы}}), либо общую навигацию (в том числе через навигационные шаблоны, например {{Tl|Языковые шаблоны}}). При этом чтобы в такой документации упомянуть имя текущего шаблона, можно обойтись без [[Википедия:Переменные|специальных переменных]] — достаточно написать {{Tcl|Tl}}. В блоках навигации по группе шаблонов используйте для ссылок на шаблоны шаблон {{Tl|tnav}} (например, {{Tc|tnav|''шаблон''}}), и тогда название шаблона, на странице которого вы находитесь, будет выделен жирным.
* Чем у́же сфера применения шаблона, тем хуже скоординирована работа над ним между разными участниками. Для шаблонов, не отличающихся большим вниманием к себе, можно прямо в тексте документации создать раздел «Необходимо/Можно сделать», где описать насущные потребности. Если вы считаете, что необходимо внести какое-то изменение в малоизвестный шаблон, но в обсуждении никто не отвечает, этим тоже можно поделиться со «случайными гостями» на странице документации.