Spanish

Documentación Del Software De la EscrituraBynum/Peterson
Capítulo 4 – El escribir a la ayuda – Referencia

Donde el capítulo 3 trató la documentación de proceso de la escritura (escritura a la guía), el capítulo 4 se centra en la documentación de la referencia de la escritura. La aserción de It’s Barker’s que los manuales de referencia están engranados hacia los utilizadores que son peritos en usar el software y necesita solamente ir al material de referencia para las respuestas en situaciones complicadas. Él dice que los documentos de la referencia contienen generalmente “how muy pequeño to” a la información. Su función es dirigir al utilizador sobre un cañizo y permitir que him/her continúe encendido con una tarea.La documentación de la referencia (o ayuda) puede tomar muchas diversas formas, incluyendo:descripciones del comando del §descripciones del menú del §listas del § de definicionesdescripciones de la función del §ejemplos del §mensajes de error del §Barker promueve el uso de las cinco guías de consulta siguientes de desarrollar los materiales de referencia eficaces:1. Elija la forma derecha de referenciaBarker indica que los usuarios experimentados que van a los materiales de referencia están buscando generalmente una respuesta rápida a una pregunta o a un problema específica. Hay varios formatos estándares que se prestan a diverso scenarios—appendices, a los ficheros del readme, a las ayudas de trabajo, y a los flipcards. Estas convenciones permiten que un utilizador experimentado del software sepa dónde esperar encontrar la información que necesitan.2. Decida qué incluirCuando escribir a documentación de la referencia una persona debe decidir a qué asuntos para incluir, por ejemplo comandos, elementos del interfaz, y/o definiciones de términos.3. Establezca un modelo“Recognition con regularity” describe esta guía de consulta. Un documento acertado de la referencia relanza los modelos constantes que proporcionan a familiaridad a los utilizadores.4. Ordene La Sección De la ReferenciaLa documentación de la ayuda requiere tomar decisiones en la pedido del material será presentada. Hay dos opciones de organización básicas: alfabético y menu'-por-menu'. Barker dice que hay una ventaja a usar el formato del menu'-por-menu'.5. Muestre cómo utilizar la sección de la referenciaSi los utilizadores son familiares con la diversa documentación de la ayuda del formato pueden tomar, las instrucciones no son generalmente necesarios. Sin embargo, si se combinan los formatos múltiples, una sección introductoria podría ser beneficiosa.
Fijado por Anne