Escribe una vez, publica en todas partes
Gracias a la fuente única de verdad de EKR Orchestra, es posible escribir todo una vez y utilizar esa información en todas las publicaciones de cada medio.
Hago un llamamiento a todos los involucrados en la producción de contenidos: la gestión de datos e información, y su correcta reutilización en documentación técnica compleja, son cada vez más importantes para hacer más eficiente el trabajo.
Pero saber cómo hacerlo de manera eficaz es más difícil.
¿Alguna vez has oído hablar de Single Sourcing?
En la documentación técnica se rechaza en este principio: debe escribir su contenido solo una vez, en un lugar (una «fuente única») y luego poder:
- Utilice el contenido que ha creado en varios contextos, por ejemplo, para producir documentación para diferentes productos u otras variaciones, en lugar de tener que copiar y pegar.
- Publica tu contenido en diferentes formatos y medios: PDF, HTML, Mobile, etc.
Obviamente, el objetivo final es una producción y gestión de contenido más eficiente. «Facilite la reutilización»
La enseñanza de principios y técnicas de programación.
Los programadores se han encontrado resolviendo los mismos problemas que quienes tienen que lidiar con la edición de contenido reutilizable y tienen principios codificados que pueden ser útiles a tener en cuenta para crear contenido reutilizable.
1. Keep It Simple, Stupid (KISS)
Significa que debe escribir de la manera más sencilla posible. No se deje atrapar por tratar de ser demasiado inteligente o presumir con un párrafo complicado. Si puede expresar un concepto en una línea, escríbalo en una línea. En programación, esto se refiere al hecho de que siempre hay muchas formas de obtener funcionalidad, pero la forma más sencilla suele ser la mejor. (Los educados pueden referirse a la navaja de Occam como un principio similar).
2. Don’t Repeat Yourself (DRY)
El principio Don’t Repeat Yourself (DRY) claramente significa no te repitas. Este es un error bastante común. La idea misma del abastecimiento único es que debes empezar a pensar que cada vez que «te repitas» podrías, además de perder el tiempo, hacer algo mal.
Entonces, en lugar de repetir el mismo contenido en varios lugares, debes pensar: ¿hay alguna forma de que pueda reutilizar este contenido?
3. Principio de conocimiento mínimo «Principio de conocimiento mínimo» o Ley de Deméter, a menudo abreviado como «LoD»
Este principio se puede traducir con el lema «no hables con extraños».
Debes apuntar a que tus temas sean «autónomos» y, por ejemplo, ten cuidado de que no cree «dependencias» entre tus bloques de contenido. Para ser más concreto: no cree vínculos entre oraciones innecesariamente. Y si desea que los temas sean reutilizables en muchos contextos diferentes (por ejemplo, documentación para varios productos), entonces no puede asumir que un «otro» tema al que se vincula, en un contexto de publicación diferente, realmente estará allí.
4. Principio de responsabilidad única (single responsibility principle, SRP abreviado)
Este principio se refiere a la idea de que un tema debe tener una sola responsabilidad, o tarea. Esto significa que solo debe cumplir un propósito.
Si mezcla dos tipos de información en una oración, será difícil reutilizarla. Luego, refactorice y divídalos en oraciones y bloques más pequeños.
5 No lo vas a necesitar ( you ain’t gonna need it YAGNI)
De acuerdo con este principio, un programador no debe desarrollar software que implemente funcionalidad que no se solicite explícitamente. Es decir: no intentes resolver un problema que no existe. Al intentar escribir «DRY», algunos pueden traicionar este principio si intentan escribir lo más abstracto y genérico posible. Aplicar el principio DRY solo cuando sea necesario.
6. Principio de abstracción y generalización
Cuando se realizan funciones similares mediante distintas piezas de código, generalmente es ventajoso combinarlas en una dejando de lado las partes variables. # S #
En otras palabras: si tiene la capacidad de hacer que una función sea genérica en lugar de específica, hágalo, si la hace demasiado específica, no será reutilizable.
En el contexto de la redacción técnica, lo mismo es cierto: si tienes la capacidad de hacer un tema más «genérico» mientras mantienes la comprensión, hazlo. Por ejemplo, imagina que estás escribiendo sobre dos productos diferentes pero similares. Tienen la misma descripción, la misma información de seguridad, etc., y lo único que difiere es el nombre del modelo. Lo que dice este principio es: si realmente no necesitas mencionar el nombre del modelo del producto, ¡no lo hagas! # S #
Para concluir
Deja tu ego fuera de la puerta y evita escribir de forma loca.
No escribes para impresionar a extraños.
No intente cerrar un montón de conceptos en una línea.
Si lo que escribe es fácil de leer, será fácil de mantener y fácil de traducir.
Recuerde que, en un mundo globalizado, sus textos deberán ser traducidos. Lo más probable es que el 80% de los que lean lo que escribiste lo leerán con las palabras del traductor y cómo lo entendió.
Trate de ser claro.
¿Que estas esperando? ¡Contáctenos para más información!
