No ha mencionado si escribirá para un negocio internacional o local. El tono de cualquier escritura depende en gran medida de la audiencia para la que está escrito. Suponiendo que va a escribir para un negocio internacional, esto es lo que tengo que decir:
Escriba primero la toma de decisiones, la resolución de problemas y el contenido basado en tareas
Cuando las personas comienzan a usar el software, generalmente necesitan decidir qué hacer con él primero, o averiguar cómo usar las diferentes características del software o resolver un problema con el software. Crear contenido que los ayude a hacer esto fácilmente debería ser su prioridad.
- ¿Cuál es el mejor sitio web para aprender español?
- Cómo eliminar datos de un sitio web y transferirlos a la interfaz de usuario de mi propio sitio web
- ¿Cuáles son los sitios web que se desarrollan utilizando php?
- Como desarrollador, ¿cómo puede crear cualquier proyecto que se le ocurra, como una aplicación móvil o un sitio web? ¿Cómo lo resuelves?
- ¿Cómo es mi sitio web https://6dollarapps.com/?
Luego puede pasar a temas conceptuales. Pero incluso aquellos deben apoyar una tarea o decisión en el software.
NO pierdas el tiempo para llegar al punto
Recuerde que alguien estaría leyendo su contenido para encontrar una solución a un problema técnico o responder a una pregunta técnica específica. Considere el nivel de conocimiento técnico de su audiencia y evite bombardear al lector con mucha información innecesaria solo porque sienta que es importante comunicarse.
Escriba, edite y repita hasta obtener el contenido más ágil posible. Y como dice Copyblogger, elimine su contenido de estas palabras:
- Nunca antes
- Ninguno en absoluto
- Aún persiste
- En el presente
- ¡Y muchos más!
Usa un inglés simple y fácil de entender
Abstenerse de usar palabras elegantes, no importa cuánto desee. Tenga en cuenta que el propósito de su contenido es resolver un problema y, por lo tanto, evite:
- Ambigüedad : no “La instalación llevará un tiempo”, sino “La instalación tomará 6 minutos”.
- Capitalización que no se necesita : a nadie le gusta leer cosas que están escritas de esta manera. Es molesto. Escriba con mayúscula las primeras letras de solo nombres propios y / u otras terminologías importantes.
- Escribir en primera persona : a menos que se lo solicite específicamente, evite escribir contenido técnico en primera persona.
Presta atención al orden de las palabras y al formato.
El orden en que usa las palabras y la forma en que formatea su contenido pueden ser confusas para algunos lectores. Es posible que haya explicado todo en el siguiente párrafo, pero si los lectores se confunden o encuentran algo difícil de entender, es posible que no lean el siguiente párrafo.
Incluir imágenes
Ya se trate de diagramas, diagramas de flujo, gráficos o capturas de pantalla, utilice imágenes para ofrecer algo que respalde lo que está escribiendo y garantice que el lector permanezca con usted hasta el final del documento.
Los elementos visuales agregan credibilidad a la información que está proporcionando y también equilibran el texto. Leer trozo tras trozo de texto se vuelve monótono. Agregar imágenes elimina esa monotonía.
Las imágenes proporcionan otro modo de comprensión, aprovechando la parte de nuestro cerebro que aprende de las representaciones visuales. Las imágenes no siempre son fáciles de crear, pero valen la pena el tiempo y el esfuerzo.
Ten en cuenta la movilidad
En muchas áreas de negocios, el móvil es la forma principal en que se llevan a cabo los negocios. Teniendo esto en cuenta, muchos escritores ya han comenzado a adaptar su estilo para un mejor consumo en la web móvil. Tal vez sea hora de que hagas lo mismo.
Piense en fragmentos de texto del tamaño de un bocado. Condense la información en tan pocas líneas como pueda administrar.
Facilita la lectura con viñetas
Las viñetas son tus amigos. Inclúyalos siempre que pueda. Este formato es mucho más fácil de leer que los largos párrafos de texto. A veces, use subpuntos dentro de viñetas para darle más sabor a las cosas.
Por cada punto que escriba, asegúrese de probarlo usted mismo primero
Probar las instrucciones no será fácil. De hecho, puede ser bastante complicado. Es posible que deba configurar un servidor especial o crear un entorno especial para este propósito. El proceso también puede implicar probar ciertas cosas con las que no tienes mucha experiencia.
Pero confía en mí, vale la pena. Los lectores saben la diferencia entre el contenido técnico escrito después de la investigación de la información y escrito desde la experiencia de primera mano. Así que colabore con un QA (Quality Assurance, también conocido como Software Tester) y continúe con él. Las personas de control de calidad pueden ayudarlo mucho porque conocen el sistema mejor que nadie. Pueden configurar entornos para garantizar que las funcionalidades funcionen como deberían.
La mejor parte es que las personas de control de calidad generalmente tienen un conjunto de casos de prueba para cada lanzamiento de producto. Por lo tanto, pueden ayudarlo en más de un sentido y facilitarle mucho la escritura.
Además, no se detenga en el nivel de control de calidad, hable con los gerentes de producto para obtener toda la información de nivel superior que necesita.
Consejo de bonificación:
Los desarrolladores casi siempre asumen que los usuarios están tan familiarizados con la tecnología como ellos. Manténgase alejado de esta mentalidad y escriba asumiendo que la base de conocimiento de los usuarios está al menos un par de puntos por debajo de lo que piensan sus desarrolladores. Siempre es mejor escribir algo demasiado simplificado en lugar de algo críptico.
He tratado de cubrir los conceptos básicos que debe tener en cuenta al escribir contenido técnico. Recuerda que la mejor manera de mejorar es seguir escribiendo. Escribe regularmente. Si lo desea, incluso puede comenzar un blog técnico donde escribirá al menos una publicación por semana. Solicite a sus desarrolladores, personal de control de calidad y gerentes de productos que contribuyan a ello. Dé crédito cuando sea necesario y recibirá la ayuda que necesita de esos profesionales.
Disculpas por la respuesta tardía. Espero que mi respuesta te ayude. 🙂
