Share
Hace muchos años, escribía manuales técnicos para clientes. En general, estos documentos tomarían la forma de documentos en papel, con cientos de páginas de información técnica impresas y probablemente utilizadas como un lugar práctico para descansar una taza de café por la mayoría de las personas para las que fueron producidos. Si el cliente era excepcionalmente avanzado, podría haber habido una versión PDF, pero rara vez se usó.
Los tiempos han avanzado, y la mayoría de los manuales, o las bases de conocimiento, como se les conoce a menudo, están en formato digital. Pueden tomar la forma de una aplicación o sitio web, o algún tipo de simulación, pero siempre tendrán datos en su núcleo. Las bases de conocimiento deben ser fáciles para que los usuarios puedan buscar y navegar, y deben ser fáciles para que los escritores agreguen o editen contenido, sin tener que trabajar en ningún dato más de una vez.
Esta es la razón por la cual cualquier sistema que sea manejado por una base de datos será el más apropiado. He estado usando WordPress para manejar este tipo de sitio web interno por un tiempo y encuentro la flexibilidad que WordPress le brinda sobre cómo visualizar y consultar los datos, combinada con la interfaz de administración que es familiar para mucha gente, que sea un ideal herramienta.
En esta serie, te mostraré que sabes cómo construir una base de conocimiento con WordPress. Te llevaré por los siguientes pasos:
La primera parte de esto es la planificación, que cubriré aquí. A lo largo de esta serie, trabajaré en una base de conocimientos imaginarios y proporcionaré cualquier código para que pueda usarlo usted mismo..
El primer paso es identificar qué tipos de contenido contendrá su base de conocimientos. Mi base de conocimientos será un recurso para usuarios y desarrolladores de WordPress..
Contendrá los siguientes tipos de contenido:
Este contenido se ordenará de acuerdo con el público objetivo y los temas de alto nivel. También hará uso de etiquetas para una clasificación más detallada..
Mi audiencia se divide en dos grupos:
Para los desarrolladores, los temas de alto nivel son:
Para los usuarios, los temas de alto nivel son:
Como ya se mencionó, el sitio también utilizará etiquetas que serán agregadas por los colaboradores. Estos no serán específicos para usuarios o desarrolladores..
El sitio será administrado por un equipo imaginario de expertos de WordPress que están todos ocupados con otro trabajo, por lo que deben poder agregar contenido rápidamente. Algunos de ellos usarán la aplicación móvil de WordPress para agregar contenido.
Habiendo identificado cuál será mi contenido, debo hacerlo coincidir con los tipos de contenido de WordPress.
Al igual que con tantos aspectos del desarrollo con WordPress, no hay necesariamente una sola forma de hacer coincidir su contenido con la forma en que está organizado WordPress. Por lo tanto, para identificar el más apropiado para usted, debe comenzar por entender cómo WordPress organiza el contenido..
Fuera de la caja, WordPress viene con tres tipos de contenido:
Tenga en cuenta que hay otros tipos de contenido en WordPress, como enlaces, comentarios y elementos del menú de navegación, pero los tres anteriores son los más relevantes aquí.
También puede agregar sus propios tipos de contenido, creando tantos como necesite, usando tipos de publicaciones personalizados. Estos pueden comportarse como publicaciones o páginas, la principal diferencia es que las páginas son jerárquicas y las publicaciones no. En este caso, la jerarquía no es un problema para mis tipos de contenido principales.
WordPress tiene dos taxonomías integradas, que puede usar con sus publicaciones, páginas y tipos de publicaciones personalizadas:
Además, puede registrar taxonomías adicionales para permitir una mejor clasificación y consulta de sus datos.
Si su base de conocimiento tiene múltiples tipos de contenido, puede lidiar con esto de una de las siguientes tres maneras:
La primera opción es la más fácil para los principiantes, ya que no tiene que escribir ningún código personalizado y puede trabajar con WordPress como viene. La segunda opción le brinda más flexibilidad y es un enfoque eficiente si desea enumerar todos sus tipos de contenido en lugar de dividirlos siempre. También es útil si una parte del contenido puede incluir más de un tipo de contenido. La tercera opción le brinda la mayor flexibilidad siempre y cuando sus tipos de contenido siempre estén separados.
En el caso de mi base de conocimientos, parte de mi contenido puede ser de más de un tipo de contenido (por ejemplo, una sugerencia rápida puede tomar la forma de un video o incluir un enlace), por lo que no voy a registrar tipos de publicación separados . En su lugar, crearé una taxonomía personalizada para mis tipos de contenido.
Además de los tipos de contenido, debo pensar en cómo se clasifican mis datos. Cada publicación estará en uno o más temas con una o más audiencias. Dado que los temas se relacionan claramente con los dos grupos de audiencia, registraré dos taxonomías: una para temas de usuarios y otra para temas de desarrolladores. Esto significa que puedo enumerar los temas para cada audiencia en las páginas relevantes del sitio.
Esto significa que mi base de conocimientos utilizará lo siguiente:
Así que tendré que registrar esas tres taxonomías pero no tendré que registrar ningún tipo de publicación. Además, como no usaré categorías integradas, las voy a desactivar para que mis autores no asignen elementos a categorías por accidente..
Ahora que sé qué contenido incluirá mi base de conocimiento y cómo se almacenarán los datos, debo pensar en la estructura de las páginas de mi base de conocimiento. El sitio utilizará una combinación de archivos y páginas estáticas, con una página de inicio que incluye las últimas publicaciones de todos los temas.
También tengo que pensar en mi navegación, así como en la navegación en el menú, voy a incluir la navegación de temas en la barra lateral y también un cuadro de búsqueda.
Entonces, mi sitio incluirá:
Incluiré una barra lateral y un pie de página en todas las páginas de mi sitio, pero variaré ligeramente según la zona del sitio en la que se encuentre el usuario..
Esto es lo que estará en la barra lateral:
Todo esto suena un poco complicado, pero comenzará a tener sentido cuando comencemos a construirlo. Crearé cada uno de estos elementos con una función y luego usaré etiquetas condicionales para adjuntar las funciones a un gancho de acción que agregaré a la plantilla de la barra lateral. También agregaré un área de widgets a la barra lateral por si acaso.
El pie de página incluirá listas de los términos de taxonomía para mis tres temas, además de una lista de las últimas publicaciones..
Esto significa que necesitaré los siguientes archivos de plantilla:
Accentsconagua
index.phppage.phparchive.phpsingle.phpbarra lateral.phpAgregaré un gancho de acción, que me ayudará a poblar las barras laterales: a tutsplus_sidebar gancho de acción en barra lateral.php.
Crearé una función adjunta a este gancho, que contendrá las siguientes listas:
Cada uno de estos incluirá etiquetas condicionales para que se agreguen a la barra lateral en las páginas correctas.
Ahora tengo un plan para el contenido y la estructura de mi base de conocimientos y lo he combinado con las capacidades de WordPress. Así que he identificado exactamente lo que necesitaré crear en WordPress para hacer que esta base de conocimientos funcione.
Si bien es tentador sumergirse y comenzar a codificar, es una buena idea dedicar un tiempo a planificar su base de conocimientos de esta manera para que sepa exactamente qué archivos de plantillas y funciones necesitará. De esa manera cuando llegues a escribir el código, será mucho más rápido..
En la siguiente parte de esta serie, le mostraré cómo registrar tipos de correos y taxonomías para los datos de su base de conocimientos y eliminar los que no necesite..
