Cómo hacer una guía increíble

Cualquier guía es mil veces mejor que ninguna guía. Las siguientes no son reglas, sino directrices. Incluso nosotros olvidamos a veces seguirlas todas, o volvemos atrás y reeditamos algo si es necesario. Sabemos que todos somos humanos y que cometemos errores. Estas guías mejorarán con el tiempo, así que no sientas que todo tiene que hacerse a la perfección a la primera. ¡Sé un pionero!

Las fotos excelentes son el factor número uno que atraerá a la gente a tu manual de reparación. Tomar fotos excelentes es totalmente posible con un equipo económico. Tómate un tiempo antes de tu sesión para estudiar nuestros tutoriales de fotografía.

Las imágenes y el texto deben complementarse entre sí. Se pueden utilizar imágenes adicionales para complementar las explicaciones textuales, y viceversa.

Palabras vagas como "cosa", "parte" y "algo" llevan a manuales de reparación ambiguos. Si no sabes cómo se llama algo, haz todo lo posible por identificarlo buscándolo en Google o preguntando a alguien. Los dispositivos pueden tener varias piezas internas intrincadas; llamar a una pieza "esta cosa" no ayuda a nadie.

La orientación del objeto debe permanecer igual tanto como sea 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 declaración como "Dale la vuelta al dispositivo" o "Gira el dispositivo 90 grados en el sentido de las agujas del reloj" para ayudar al lector a hacer lo mismo.

Un poco de información general es genial: por qué estás haciendo esto, quién se beneficiará de la guía, qué necesita hacer la gente para prepararse para la guía. Sin embargo, déjalo ahí; la mayoría de la gente en internet se estremece 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?).

Los enlaces cruzados son tus amigos. Enlaza todo lo que puedas a recursos relevantes en otras partes del sitio.

Aunque nos encantan las historias sobre tu bisabuela metiendo helado en su bolso (¡historia real!), hay un contexto apropiado para tales historias. El medio de un manual de reparación no lo es.

Añadir más información pertinente da autoridad a tu manual de reparación.

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

Puedes crear un montón de confusión usando viñetas de forma inapropiada. Dedica un segundo a leer sobre el significado de cada viñeta antes de usarla. En caso de duda, ¡usa la predeterminada!

Es posible que el dispositivo no requiera notas de reensamblaje si es lo suficientemente sencillo. Pero volver a ensamblarlo también puede requerir instrucciones especiales. Por ejemplo, desmontar una pantalla LCD de un MacBook es bastante sencillo. Sin embargo, si no diriges el cableado correctamente durante el reensamblaje, no llegarán a sus puntos de conexión en la placa lógica. Los lectores te agradecerán amablemente si incluyes pequeños consejos para ayudarles a reensamblar el dispositivo una vez que esté en piezas.

Las imágenes y el texto solo pueden llegar hasta cierto punto en algunas circunstancias. Añadir un diagrama o dos (y subirlo como una imagen) sin duda ayudará al lector a averiguar cómo repararlo.

Añadir demasiadas marcas hará que la imagen parezca extrañamente poco atractiva para el lector. Añade solo lo suficiente para identificar de qué estás hablando, si es que crees que se necesitan marcas en absoluto. Si añades más de 4-5 marcas, quizás quieras dividir el trabajo en varios pasos. En caso de duda, ¡mira algunas guías de iFixit!

Usa los títulos de los pasos con moderación. Añadir las guías de prerrequisitos correctamente añadirá automáticamente una estructura de navegación adecuada, por lo que los títulos de los pasos son innecesarios en la mayoría de las circunstancias.

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

Estamos aquí para ayudarnos unos a otros a aprender a reparar cosas. Reserva tus puntos de vista políticos y otras opiniones similares para el lugar apropiado.

Sé directo en tus instrucciones al usuario. No caigas en la trampa del "Es" o "Se debe", y en su lugar usa verbos para transmitir lo que intentas decir.

Sube solo fotos y texto que poseas o de los que tengas los derechos.