Las plantillas son una característica muy poderosa de MediaWiki , pero pueden resultar confusas para los nuevos usuarios e incluso los usuarios experimentados pueden tener dificultades para entender las más complejas. Por lo tanto, las plantillas deben ir acompañadas de documentación para mejorar la usabilidad.
La documentación de la plantilla debe explicar qué hace una plantilla y cómo usarla. Debería ser lo suficientemente simple como para que un usuario sin un conocimiento completo de las complejidades de la sintaxis de la plantilla, que incluye a muchos colaboradores experimentados que enfocan su atención en otra parte, pueda usarlo correctamente. Esto es especialmente cierto en el caso de plantillas muy utilizadas.
Los editores deben ceder a las políticas o pautas oficiales cuando las páginas de documentación de la plantilla no concuerden con los estándares y principios establecidos por la comunidad. Los editores también deben evitar "citar" las páginas de documentación de las plantillas como si fueran políticas, incluida esta guía práctica . Las páginas de documentación de plantillas se pueden escribir sin mucho debate, si es que lo hay, a diferencia de las políticas de Wikipedia que han sido examinadas minuciosamente por la comunidad (consulte WP:Consenso local para obtener más detalles).
La Wikipedia en inglés es una fuente de plantillas para cientos de otras Wikipedias y proyectos hermanos. A menudo, las plantillas son completamente independientes, por lo que el proceso es fácil: los contenidos simplemente se copian en una nueva página de plantilla en la otra wiki y todo funciona. Sin embargo, en plantillas más complejas, la plantilla puede invocar un módulo, transcluir otras plantillas, solo funciona si se combina con una plantilla separada o necesita un código CSS o JavaScript particular para funcionar. En estos casos, es útil incluir una breve lista de plantillas u otro código que este requiera, al final de la documentación.
Al ver la página de la plantilla renderizada (a diferencia de su código wiki), lo que generalmente se ve justo debajo del título es la plantilla renderizada, seguida de una sección separada para mostrar la documentación renderizada de la plantilla, seguida de las categorías a las que pertenece la plantilla. . Las categorías y la documentación de cualquier tipo en una página de plantilla (incluido TemplateData ) siempre deben incluirse entre etiquetas noinclude para que no se muestren cuando la plantilla se usa en otra página.
El wikicode editable para la documentación de la plantilla a menudo se coloca en una subpágina separada de la propia plantilla, que luego se transcluye al final de la página de la plantilla. Esto separa el código de la plantilla, a menudo complejo, de la documentación, lo que facilita la edición de la documentación y reduce la cantidad de errores de edición accidentales en el código de la plantilla. También permite proteger las plantillas cuando sea necesario, lo que limita el acceso de edición al código de las plantillas importantes y permite que cualquier persona edite la documentación de esas plantillas. Este método a veces se denomina "patrón de página plantilla-doc".