¿Cuáles son algunas pautas para crear una buena documentación de software?

“Cómo” rara vez es suficiente.

  1. Identifique lo que su usuario quiere lograr con la función.
  2. Identifique qué tipo de idioma entiende su usuario, qué nivel de conocimiento previo tiene, etc.
  3. No empieces escribiendo “cómo”. Comience con el contexto: para qué está diseñada la característica, cuándo debe usarla el usuario, cuáles son las consecuencias (si las hay) de usarla en una situación incorrecta. Esta es su introducción, o si hay mucho que cubrir, conviértalo en un tema conceptual por derecho propio con enlaces entre ambos y el ‘cómo hacerlo’.
  4. Escriba su procedimiento de “cómo hacerlo”. Cuando lo estés escribiendo, hazlo (si puedes). Esto lo ayudará a hacerlo bien y no hacer suposiciones. Además, tenga en cuenta lo que sucederá si el usuario realiza una selección inadecuada o comete un error y aconseje sobre cómo salir de eso.
  5. Incluya enlaces a cualquier otro tema que pueda ser relevante, como características relacionadas, descripciones conceptuales, ejemplos, tutoriales, etc.

Así es como me acerco a mi trabajo y les brinda a los usuarios una comprensión mucho más completa de la función del software. Puramente ‘cómo’ solo les dice cómo hacer algo, pero si no sabían que tenían que hacerlo, ¡no sirve de nada!

Oh fantástico, justo en mi callejón.

Voy a vincularlo directamente a mi folleto: 5 maneras fáciles de mejorar la documentación de su producto

Repasa algo que he desarrollado llamado las 4 C de la buena escritura: clara, concisa, completa y coherente, así como los pasos fáciles para lograrlos.

Puede encontrar el documento en http://www.deepcoredata.com/wp-c

Me gusta la respuesta de Rhiannon Chiacchiaro porque tengo mi propia ‘C’:

Claro, conciso y correcto.

Solía ​​incluir Completo, pero, especialmente con la documentación del software, a menudo hay 2 o más formas de completar una tarea. Para un documento para principiantes, por ejemplo, generalmente solo necesita un conjunto de instrucciones. Todas las otras formas deben estar en algún lugar, pero no necesariamente en un documento.

Agrego Correcto porque, aunque es obvio, nunca debe olvidarse. Es cierto, pero triste, que mucha (probablemente la mayoría) de la documentación nunca se prueba y nunca se demuestra que sea correcta.

Realmente me gusta la regla consistente; Creo que lo agregaré a mi lista. Claro y conciso es necesario, pero no suficiente, para garantizar la coherencia.

En el mundo actual, el software debe ser intuitivo y fácil de usar y debe requerir un mínimo de documentación de “cómo hacerlo”. Si descubre que tiene que escribir una cantidad significativa de documentación de “cómo hacerlo”, es posible que el software no esté bien diseñado.

Chuck Cobb
Autor de “La guía del administrador de proyectos para dominar Agile”
Echa un vistazo: Academia de gestión de proyectos ágil