El sitio de documentación
Para editores autorizados que publican documentación de productos POM. Este capítulo cubre la ruta completa desde un origen Markdown seguro para producción hasta una publicación de documentación pública revisada.
En este capítulo
| Tema | Artículo |
|---|---|
| Importar y actualizar desde Markdown | Sincronizar documentos desde Markdown |
| Buscar y ordenar documentos manualmente | La biblioteca Docs |
| La navegación del lector | Shortcodes de navegación de documentación |
| Mostrar un archivo Markdown en una página | El shortcode de Markdown a HTML |
A quién va dirigido este capítulo
A las personas que mantienen el origen de la documentación o el sitio de documentación dedicado. La sincronización está disponible solo en ese sitio y únicamente para usuarios con los permisos necesarios de documentos y categorías. Si estás leyendo documentación en lugar de publicarla, nada de este capítulo te aplica.
Cómo encajan las piezas
- La documentación del producto se escribe como Markdown público en cada repositorio del producto, organizada en directorios de temas numerados con un manifiesto completo.
- Sync docs valida esos archivos y crea o actualiza una publicación de documentación por cada uno, con categorías que reflejan la estructura de directorios.
- Un editor revisa los nuevos borradores y las páginas publicadas afectadas antes de hacer público el resultado.
- La biblioteca Docs ofrece a los editores una vista con la jerarquía en primer lugar, con ordenación por arrastrar y soltar para los documentos que no se gestionan desde Markdown.
- Los shortcodes de navegación construyen el menú del producto, el índice de la página y la llamada a la acción del producto que ven los lectores.
El manifiesto es la autoridad en cuanto al orden. Ese único hecho resuelve la mayor parte de la confusión sobre por qué una reordenación manual no se mantuvo.
La división del trabajo
| Lo decide | Qué |
|---|---|
| El Markdown y el manifiesto del producto | Qué documentos sincronizados existen, su contenido y su orden |
| La biblioteca Docs | El orden manual de los documentos sin origen Markdown |
| Los shortcodes y el tema | Cómo navegan y leen los lectores |
Editar el contenido de un documento sincronizado en WordPress no es la forma de cambiarlo: la siguiente sincronización lo sobrescribe. Cambia el Markdown.
Flujo de trabajo recomendado
- Ejecuta Sincronizar documentos desde Markdown.
- Revisa el resumen de sincronización y cada borrador nuevo.
- Inspecciona el resultado en La biblioteca Docs.
- Confirma la navegación, los enlaces y las imágenes en el sitio público.