• Articles
• admin

¡Muy bien! ¿A quién le entusiasma hablar de manuales de usuario?

Mira, voy a conseguir. Pero si eres como yo, entonces estás de acuerdo en que documentar procesos & sistemas es esencial para cualquier organización sin fines de lucro. Es solo cuestión de encontrar el tiempo para hacerlo.

¿Y por qué no lo haríamos? La documentación nos ahorra tiempo a largo plazo. Nos evita la solución de problemas de reuniones innecesarias &, al capacitar al personal para que encuentre sus propias respuestas.

Sin mencionar que es una maldita buena habilidad para tener. Y es crucial para mantener su trabajo, en caso de que & su organización se separe.

Intente reservar tiempo para hacer esto. Los pasos a continuación deben ayudar a que esto sea lo más indoloro posible, y si no, hay un «regalo de regalo» hacia el final que querrá agarrar.

Comenzar con un esquema.

Antes de escribir procedimientos y definiciones, considere la estructura de su documento. ¿Cuáles son los temas que será fácil de seguir para el personal? ¿Y qué estructura será fácil de actualizar con el tiempo?

Spoiler: ¡esto se convierte en tu Índice!

Para example…my el manual de Salesforce de team está dividido principalmente por objetos. Pero dependiendo de su configuración, dividir los temas por departamento o función puede tener más sentido.

Empieza con broad. Luego, estrecha.

Su manual debe tener detalles específicos e instrucciones paso a paso. Básicamente, todas las cosas que nuestros colegas siguen olvidando.

Pero una buena documentación también le dará una visión útil y a vista de pájaro de cómo está organizado su sistema & por qué. Tenga esto en cuenta al planificar su esquema en el Paso 1.

p. s. Recomiendo encarecidamente diagramar su modelo de datos. Puedes usar una herramienta gratuita como Dibujos de Google, o crear algo en un documento de Word o Powerpoint (usando líneas de formas &). ¡No tiene que ser elegante!

Defina todos sus datos.

Cada activo tecnológico en su base de datos es una manifestación de alguna «cosa» de la vida real: ya sea una persona (donantes, voluntarios, etc.), una transacción (donación, subvención, etc.)..), o asociación (entrega del programa).

Una buena documentación cerrará la brecha entre lo real y lo técnico, al definir lo que los campos objetos & representan en el mundo real.

Meta, lo sé.

Instruye a tus usuarios.

Su manual de usuario debe hacer dos cosas: definir e instruir.

Si el personal necesita realizar tareas en su base de datos (entrada de datos, actualizaciones de datos, incluso búsquedas), ayúdelos incluyendo instrucciones paso a paso para esas cosas.

Sugerencia: Las listas numeradas & las oraciones cortas son tu amigo aquí.

Escribe todo una vez. Luego recorta, repetidamente.

Todos conocemos el dolor de leer un manual que es largo, prolijo y lleno de texto. Perdona a tus colegas. Saca ese primer borrador y planea pasar mucho tiempo recortándolo.

¿Por qué? Porque menos es más. Y se necesita tiempo para reunir documentación que sea completa y eficaz, sin dejar de ser concisa.

p.d. No estoy diciendo que cortemos las cosas por brevedad. Estoy diciendo que la documentación concisa es un arte, uno que no aterriza en el primer intento.

Haga uso del espacio en blanco.

Piense en esto en términos de UX (experiencia de usuario). De la misma manera que le importa que su base de datos sea fácil de usar, también desea que su manual sea fácil de navegar.

Cuanto más espacio en blanco haya, el espacio entre / alrededor de su texto, mejor. También considere el tamaño de la fuente, la altura de la línea y el espacio entre viñetas.

Solo usa capturas de pantalla donde sea necesario.

Las capturas de pantalla son fantásticas. ¿Por qué explicarle algo a alguien cuando también se lo puedes mostrar?

Pero personalmente creo que son una trampa. Al menos cuando se trata de documentación.

Piénsalo. Si algo cambia en la interfaz de su sistema, tendrá que volver a tomar y reemplazar esas imágenes. También pueden distraerte de tus instrucciones escritas, especialmente si te dejas llevar.

Es por eso que los uso principalmente para resaltar algo que mis usuarios podrían perder.

🌟 Una cosa más que podría ayudar.

Ahora que tenemos nuestros pasos, es hora de empezar a construir! Para ayudar, he creado una plantilla de manual de usuario que comparto con cualquiera que la desee, ¡para Microsoft Word o Google Docs!

Todo lo que necesita es una dirección de correo electrónico. Para comprobarlo y tomar su copia, siga este enlace.

Ya que este es un blog de base de datos, una nota rápida! Al registrarte para recibir la plantilla, también serás agregado a la lista de correo electrónico de mi blog (que nunca comparto con terceros). Envío actualizaciones bimensuales y anuncios ocasionales, de los que puede darse de baja en cualquier momento.