Saltar al contenido principal

Cómo hacer una guía impresionante

Usa estas pautas para hacer estupendos manuales de reparación que ayudarán a reparar cosas.

Qué hacer

¡Contribuye!

Cualquier guía es mil veces mejor que ninguna guía en absoluto. Las siguientes no son reglas sino pautas. Incluso a veces nos olvidamos de seguir todas, o retrocedemos y reeditamos algo si es necesario. Sabemos que todos somos seres humanos y que cometemos errores. Estas guías se irán mejorando con el tiempo, así que no te sientas como si todo tuviera que hacerse perfectamente la primera vez. ¡Sé el pionero!

Toma fotos impresionantes

Las fotografías excelentes son lo que más atraerá a las personas a tu manual de reparación. Tomar excelentes fotos es absolutamente posible con equipos económicos. Tómate un tiempo antes de comenzar a fotografiar nuestros tutoriales fotográficos.

Aumentar imágenes con texto

Las imágenes y el texto deben aumentar entre sí. Se pueden usar explicaciones textuales adicionales y viceversa.

Sé descriptivo

Palabras imprecisas como "cosa", "parte" y "cosas" conducen a manuales de reparación ambiguos. Si no sabes cómo se llama algo, haz lo mejor para identificarlo en Google o pregúntale a alguien. Los aparatos pueden tener varias partes internas complejas. ¡Llamar a una parte "esta cosa" no ayuda a nadie!

Usa imágenes para orientar al lector

La orientación del objeto debe permanecer igual en la medida de lo posible a lo largo de la guía. El lector podrá identificar su ubicación en su propio dispositivo con mayor facilidad. Si giras el objeto, incluye una aclaración como "Voltear el dispositivo" o "Girar el dispositivo 90 grados en el sentido de las agujas del reloj" para ayudar al lector a hacer lo mismo.

Minimizar información general

Un poco de información general es excelente: por qué estás haciendo esto, quién se beneficiará de la guía, qué es lo que las personas deben hacer para prepararse para la guía. Sin embargo, déjalo así: la mayoría de las personas en Internet se estremecen ante la idea de leer un libro antes de reparar algo (¿cuándo fue la última vez que leíste el manual del usuario que venía con tu televisor?).

Enlaces entrecruzados

El entrecruzamiento es tu amigo. Vincula cualquier cosa y todo lo que puedas a recursos relevantes en otras partes del sitio.

Mantente con el tema en cuestión

Por mucho que nos encanten las historias de tu bisabuela que pone helado en su bolso (¡una historia real!), Hay un entorno apropiado para esas historias. El medio de un manual de reparación no es eso.

Sé informativo sobre el tema

Agregar más información pertinente da autoridad a tu manual de reparación.

Sé simple, no locuaz

La gente no usará tu manual de reparación si no puede entender de qué estás hablando.

Usa el marcador de viñeta apropiado

Puedes crear una tonelada de confusión usando balas inapropiadamente. Tómate un segundo y lee el significado de cada bala antes de usarla. En caso de duda, ¡utiliza la predeterminada!

Añadir notas de reensamblaje

El dispositivo puede no requerir notas de reensamblaje si es lo suficientemente simple. Pero volver a montarlo también puede requerir instrucciones especiales. Por ejemplo, desmontar una pantalla LCD de MacBook es bastante sencillo. Sin embargo, si no enrutas correctamente los cables durante el reensamblaje, no alcanzarán sus puntos de conexión en la placa lógica. Los lectores te agradecerán amablemente si incluyes pequeños trocitos para ayudarlos a volver a ensamblar el dispositivo una vez que esté en pedazos.

Incluye diagramas

Las imágenes y el texto solo pueden llegar muy lejos en algunas circunstancias. Agregar un diagrama o dos (y cargarlo como una imagen) ciertamente ayudará al lector a descubrir cómo repararlo.

Que NO hacer

No usar en exceso el marcado

Si agregas demasiadas marcas, la imagen se verá extrañamente poco atractiva para que la vea el lector. Agrega solo lo suficiente para identificar de qué estás hablando, si crees que se necesita un marcado. Si estás agregando más de 4-5 bits de marcado, puedes dividir el trabajo en varios pasos. En caso de duda, ¡mira algunas guías de iFixit!

No uses en exceso los títulos de los pasos

Usa los títulos de los pasos con moderación. Agregar guías de requisitos previos agregará automáticamente una estructura de navegación adecuada, por lo que los títulos de pasos no son necesarios en la mayoría de las circunstancias.

Evita usar a la primera persona

No hay un "yo" en el equipo, y no debería haber ninguno en tu escritura. Tiene un tono de voz más autoritario al no usar declaraciones como "Hice esto" en tus manuales.

No fuerces tus opiniones sobre otros

Estamos aquí para ayudarnos unos a otros a aprender cómo arreglar cosas. Reserva tus puntos de vista políticos y otras opiniones similares para el lugar correcto.

No uses voz pasiva

Sé directo en tus instrucciones al usuario. No caigas en la trampa "Es", y en su lugar usa verbos para expresar lo que estás tratando de decir.

No subas contenido que no tienes

Solo carga fotos y texto de tu propiedad o de los que tengas derechos.

Un agradecimiento especial a estos traductores:

100%

¡ Mariana nos está ayudando a reparar el mundo! ¿Quieres contribuir?
Empezar a traducir ›

Ver Estadísticas:

Ultimas 24 Horas: 9

Últimos 7 Días: 34

Últimos 30 Días: 135

Todo El Tiempo: 41,828