2011-07-25

Escribiendo procedimientos claros

El otro día encontré en un libro de ejercicios para aprender inglés que se trataba el tópico de cómo escribir procedimientos claros [en inglés]. En particular hubo un ejercicio que me gustó pues pedía diferenciar los “dos” y los “don’ts” (lo que hay que hacer y lo que no hay que hacer) en esta lista que les transcribo a continuación:

  1. Use long sentences
  2. Prefer active verbs
  3. Be direct – use imperatives
  4. Use long words
  5. Use abbreviations or acronyms
  6. Be consistent with terminology
  7. Remember the reader – do not assume they know certain information
  8. Put steps in the right sequence
  9. Use headings and split information into chunks
  10. Use 1, 2, 3, and not one, two, three or first, second, third

Pensemos lo que opinamos de estas sugerencias en el contexto de escribir casos de prueba y/o incidentes de prueba claros y simples: ¿Cuales serían para ustedes sugerencias para respetar y cuales no?

Seguimos pensando..

1 comentario:

  1. Ernesto, desde mi poca experiencia creo que debemos tener en cuenta lo siguiente:

    Para respetar (ordenados por importancia):
    - Ser directos, no distraer al lector,
    - Poner pasos en la secuencia correcta. ¡FUNDAMENTAL!
    - Ser consistentes con la terminologia (Más o menos importante dependiendo el dominio sobre el que se trabaja),
    - Usar encabezados y separar la información, principalmente si en el reporte hay que navegar por varios módulos,
    - Usar 1,2,3 y no one, two, three,
    - Usar active verbs.

    NO respectar (por orden de importancia):

    - NO usar sentencias largas. ¡EVITARLAS! Principalmente para descripciones.
    - NO usar palabras largas,
    - Tratar de evitar abreviaturas y acrónimos. Esto es relativo ya que depende del vocabulario técnico a veces usado. OJO que se puede caer en sus "garras" para salvar largas sentencias.

    ResponderEliminar

Muchas gracias por comentar. Por favor deja tu nombre y/o email, los comentarios son mucho más valiosos cuando se sabe quien los hace.