¡Organícate!Cómo crear un estilo de conocimiento -guía de estilo de base

Escribir una base de conocimiento ya es bastante difícil. Así que me disculpo por lo que voy a hacer en esta publicación. Le diré que no se trata solo de las ideas sobre su base del conocimiento, sino también de cómo las presenta. Mira, más allá de estas ideas, debes asegurarte de ser siempre:
Usando el tono correcto
Formatear constantemente todo lo mismo
Lo cual, por razones que aclararé en la siguiente sección, en realidad es sorprendentemente difícil. Hay un estilo de base de conocimiento entra en juego. Por qué su base de conocimiento podría ser un desastre de diferentes estilos, no se preocupe demasiado si su base de conocimiento es una mezcla de diferentes estilos. Le sucede a muchas compañías, generalmente de una de las dos razones (¡o a veces ambas!).
En primer lugar, si usted es parte de un equipo, es posible que tenga más personas que escriban documentos de asistencia. Así que si:
Jim escribe artículo un
Sally escribe el artículo B
Estos artículos probablemente tendrán estilos y formatos extremadamente diferentes … a menos que tenga una guía de estilo predefinida. Ahora, si no eres parte de un equipo, probablemente diga: “Soy un lobo solitario: escribo todo solo. Así que no tengo que poner nada en papel, ¡soy yo! ” Y este podría ser el caso … si escribiera todos los artículos en la base de conocimiento de una reunión. Pero ambos sabemos que esto no suele funcionar, ¿verdad? Probablemente escribió muchos artículos de su base de conocimiento cuando lanzó el producto por primera vez.
Pero luego, tres meses después, lanza una nueva característica. Ahora tienes que escribir la entrada a la base de conocimiento para esa nueva característica y … los recuerdos humanos no son tan buenos. Hay altas posibilidades de hacer algo diferente, incluso si no lo intentas. Entonces, ya sea que esté solo o sea parte de un equipo, vale la pena poner el estilo de la base de conocimiento en el papel. ¿Las empresas realmente hacen esto? ¿Es una guía de estilo de conocimiento estilo real? Ok, te diré cómo crear tu guía de estilo en un segundo. Pero primero, quiero ejecutar con algunos ejemplos de empresas que hacen esto. Esto logra dos objetivos: te muestra que no solo hago cosas para crear más contenido de blog
Te da un ejemplo de la vida real del que puedes dibujar para tu propia guía de estilo.
Veamos primero a Mozilla. Mozilla tiene una entrada completa en la guía de estilo para su base de conocimiento. Debido a que Mozilla es de código abierto, es esencial que tengan una guía de estilo para sus propias palabras, “para hacer una base de soporte de Firefox consistente, lo que resulta en una base de conocimiento, que es fácil de leer y contribuir”. ¿Fácil de leer? Parece un buen objetivo para su base de conocimiento, ¿verdad?
La guía profundiza, guiándole todo, desde letras mayúsculas hasta espacios blancos, hasta comas en serie. A continuación, la voz y el tono de MailChimp es otra lectura que merece. Aunque no se concentra al 100% en las bases de conocimiento, tiene una serie de entradas tanto para el contenido de la base de conocimiento como para el tutorial:

Si bien la guía de estilo Mozilla se centra más en el estilo y el formato, MailChimp opta para centrarse más en, bueno, voz y tono, que en formateo simple. Cómo crear una guía de estilo para su base. He lanzado algunos ejemplos para su conocimiento, Pero aún no te he dado una prueba para crear tu propia guía de Base de Conocimientos. ¡Así que reparemos eso!

¿Utiliza una persona consistente? ¿Alguna vez ha leído un artículo en el que el autor ha cambiado entre “yo” y “nosotros”? Tengo y podemos decirte que está extremadamente confundido. Entonces, si usa la primera persona, elija una y sea consistente con ella. Incluso si está solo, puede elegir usar “nosotros”. ¡Tú decides! Úselo en el mismo. Además, ni siquiera debe usar la primera persona. Puedes optar por evitar “yo” y “nosotros”. Realmente no hay una respuesta correcta aquí, es solo una consistencia. Estandarice su formato Si lee nuestra guía suprema de artículos de la base de conocimiento, sabe que las buenas bases de conocimiento utilizan muchas instrucciones de pasos pequeños. Y esas instrucciones incluirán, en un punto, el idioma como:

Haga clic en el archivo. Así es:
Haga clic en el archivo
Haga clic en “Archivo”
Haga clic en el archivo
Y cuando escribes tus listas, es:
Paso 1: haga clic en él
Paso 2: haga clic en él
O es esto:
Haga clic en esto
Haga clic en esto
Una vez más, puede elegir el que le guste más, pero no importa lo que elija, use constantemente a lo largo de su base de conocimiento. Hay otras opciones de formato que debe hacer: la Guía de estilo Mozilla le brinda una buena idea de todo lo que necesita estar cubierto, pero aquí hay algunas ideas iniciales: letras mayúsculas, ¿usará letras mayúsculas o mayúsculas?
Números: ¿son 10 o diez?
Abreviaturas: ¿no lo hago o no?
ACRONIME – ¿CDN o red de entrega de contenido?
Si usa uno de los temas o complementos de WordPress de nuestra base de conocimiento, las opciones de formato corta en la puerta pueden ayudarlo a mantenerse consistente cuando se trata de formatear
Obtenga la voz correcta al final, debe ir más allá del formato y estandarizar su voz. ¿Eres amigo de tu cliente? ¿O eres Spock de Star Trek, que distribuye cuidadosamente la sabiduría fría y dura? En la razón, lo que sea bueno. Siempre que sea consistente. En general, debe asegurarse de seguir los consejos de la guía de la base de conocimiento de MailChimp. Les sugiero no solo porque MailChimp ha publicado su guía, sino también porque creo que MailChimp tiene una de las mejores bases de conocimiento existentes. Su consejo es este:
Siempre haga la prioridad para responder las preguntas e informar a sus lectores. Los chistes están bien a veces, pero no se distraen de ese objetivo esencial.
Evite hablar como agente de marketing, solo intente ayudar.
¿Dónde mantener su guía de estilo? No solo debe tomar estas decisiones. También tienes que escribirlos en un lugar seguro.