¡Organizarse! Cómo crear una guía de estilo de la base de conocimientos

Escribir una base de conocimientos ya es bastante difícil. Así que pido disculpas por lo que voy a hacer en este post. Te diré que no se trata solo de las ideas en tu base de conocimientos, sino también de cómo las presentas.

Mira, más allá de esas ideas, debes asegurarte de estar siempre:

• Usando el tono adecuado
• Formateando constantemente todo igual

Lo cual, por razones que aclararé en la siguiente sección, es sorprendentemente difícil. Ahí es donde entra en juego una guía de estilo basada en conocimientos.

Por qué su base de conocimientos podría ser un desastre de diferentes estilos

No se preocupe demasiado si su base de conocimientos es un revoltijo de diferentes estilos. Le sucede a un montón de empresas, generalmente por una de dos razones (¡o a veces por ambas!).

En primer lugar, si forma parte de un equipo, es posible que haya diferentes personas escribiendo documentos de soporte. Así que si:

• Jim escribe el artículo A
• Sally escribe el Artículo B

Es probable que esos artículos tengan estilos y formatos muy diferentes... a menos que tenga una guía de estilo predefinida.

Ahora, si no eres parte de un equipo, probablemente estés diciendo: “Soy un lobo solitario, estoy escribiendo todo yo mismo. Así que no necesito poner nada por escrito, ¡soy todo mío!”.

Y ese podría ser el caso... si escribiera todos los artículos de su base de conocimientos de una sola vez.

Pero ambos sabemos que no es así como suelen funcionar las cosas, ¿verdad? Probablemente escribió un montón de artículos de la base de conocimientos cuando lanzó su producto por primera vez.

Pero luego, tres meses después, lanzas una nueva característica. Ahora tienes que escribir la entrada de la base de conocimientos para esa nueva característica y... los recuerdos humanos no son tan buenos . Es muy probable que termines haciendo algo diferente, incluso si no lo intentas.

Entonces, ya sea que esté solo o sea parte de un equipo, vale la pena poner su guía de estilo de base de conocimientos en papel.

¿Las empresas realmente hacen esto? ¿Es real una guía de estilo de la base de conocimientos?

Bien, te diré cómo crear tu guía de estilo en un segundo. Pero primero, quiero comenzar con algunos ejemplos de empresas que realmente están haciendo esto. Esto logra dos objetivos:

• Te muestra que no solo estoy inventando cosas para crear más contenido de blog.
• Le brinda un ejemplo de la vida real que puede tomar para su propia guía de estilo.

Miremos primero a Mozilla. Mozilla tiene una entrada completa en la guía de estilo para su base de conocimientos. Debido a que Mozilla es de código abierto, es especialmente esencial para ellos tener una guía de estilo para, en sus propias palabras, "hacer que la base de conocimientos de soporte de Firefox sea consistente, lo que da como resultado una base de conocimientos que es fácil de leer y contribuir". ¿Fácil de leer? Eso suena como un buen objetivo para su base de conocimientos, ¿verdad?

La guía es profunda y lo lleva a través de todo, desde mayúsculas, espacios en blanco y comas en serie.

A continuación, Voice & Tone de MailChimp es otra lectura que vale la pena. Si bien no se centra al 100 % en las bases de conocimiento, tiene varias entradas tanto para la base de conocimiento como para el contenido del tutorial:

Mientras que la guía de estilo de Mozilla se centra más en el estilo y el formato, MailChimp opta por centrarse más en la voz y el tono que en el formato esencial.

Cómo crear una guía de estilo para su base de conocimientos

Te lancé un par de ejemplos, pero todavía tengo que darte un proceso para crear tu propia guía de estilo de base de conocimientos. ¡Así que arreglemos eso!

Usa una persona consistente

¿Alguna vez has leído un artículo en el que el autor alternaba entre "yo" y "nosotros"? Lo tengo, y podemos decirle que es extremadamente confuso.

Entonces, si vas a usar la primera persona, elige una y sé consistente al respecto. Incluso si está solo, aún puede optar por usar "nosotros". ¡Depende de usted! Solo usa el mismo.

Además, ni siquiera necesitas usar la primera persona. Puede optar por evitar "yo" y "nosotros" por completo.

Realmente no hay una respuesta correcta aquí, se trata solo de consistencia.

Estandarice su formato

Si lee nuestra guía definitiva de plantillas de artículos de la base de conocimientos, sabe que las buenas bases de conocimientos usan muchas instrucciones con pequeños pasos. Y esas instrucciones, en algún momento, incluirán lenguaje como:

Haga clic en Archivo .

Por lo que es:

• Haga clic en Archivo
• Haga clic en "Archivo"
• Haga clic en Archivo

Y cuando realmente escribes tus listas, es:

• Paso 1: Haga clic aquí
• Paso 2: haz clic en eso

O es asi:

• Haga clic en este
• haz clic en eso

Nuevamente, puede elegir el que más le guste, pero cualquiera que elija, utilícelo de manera consistente en toda su base de conocimientos.

También hay otras opciones de formato que debe tomar: la guía de estilo de Mozilla le brinda una buena idea de todo lo que debe cubrir, pero aquí hay algunas ideas iniciales:

• Capitalización de títulos: ¿usará mayúsculas y minúsculas o mayúsculas y minúsculas?
• Números : ¿10 o diez?
• Abreviaturas : ¿no o no?
• Acrónimos : ¿CDN o red de entrega de contenido?

Si está utilizando uno de nuestros temas o complementos de WordPress de la base de conocimientos, nuestros códigos abreviados integrados y opciones de formato pueden ayudarlo a mantener la coherencia en lo que respecta al formato.

Obtener la voz correcta

Finalmente, debe ir más allá del formato y estandarizar su voz.

¿Eres amigo de tu cliente? ¿O eres Spock de Star Trek, dispensando desapasionadamente sabiduría fría y dura?

Dentro de lo razonable, cualquiera está bien. Siempre que sea consistente.

En general, debe asegurarse de seguir los consejos de la guía de la base de conocimientos de MailChimp. Los sugiero no solo porque MailChimp publicó su guía, sino también porque creo que MailChimp tiene una de las mejores bases de conocimientos que existen.

Su consejo es este:

• Siempre haga su primera prioridad para responder preguntas e informar a sus lectores. Las bromas están bien a veces, pero no si distraen de ese objetivo esencial.
• Evite hablar como un vendedor, solo está tratando de ayudar.

¿Dónde guardar su guía de estilo?

No deberías simplemente tomar estas decisiones. También necesita, en realidad, escribirlos en un lugar seguro.

Personalmente, la mayoría de las guías de estilo con las que trabajo son documentos de Google Docs. De esa manera, puede compartir fácilmente su guía de estilo y acceder a ella desde diferentes computadoras.

Pero si prefiere otro método, vaya con lo que está familiarizado. Lo único realmente importante es esto:

Tiene una copia de la guía de estilo de su base de conocimientos almacenada en un lugar seguro donde usted u otras personas pueden acceder a ella cuando necesite un repaso sobre cómo formatear su base de conocimientos.

Entonces, escríbalo en papel y comience a crear artículos de base de conocimiento más consistentes.