Documentar los objetivos de la codebase

Requisitos

• La codebase DEBE contener documentación de sus objetivos —como una declaración de misión y objetivos— que sea comprensible para profesionales del diseño y desarrollo, para que de esta manera puedan utilizar o contribuir a la codebase.
• La documentación de la codebase DEBE describir claramente las conexiones entre los objetivos de las políticas y los objetivos de la propia codebase.
• La codebase PUEDE contener documentación de sus objetivos para el público en general.

Por qué es importante

Documentar los objetivos de la codebase:

• Proporciona una manera fácil para que la gente decida si esta codebase es interesante para ellos ahora o en el futuro.
• Ayuda a determinar el alcance de su propio desarrollo.
• Comunica claramente a otras partes interesadas y contribuyentes para qué sirve la codebase.

Qué no hace

• Garantizar que el código base alcance los objetivos establecidos.
• Garantizar contribuciones a la codebase.
• Evitar que otras codebases intenten alcanzar los mismos objetivos.

Cómo probar o hacer tests

Hay una entrada para los objetivos, la misión o la meta de la codebase en la documentación de la misma.

Responsables de políticas y legislaciones: qué necesitan hacer

• Añadir los objetivos de las políticas a la documentación de la codebase, por ejemplo en el README.
• Incluir políticas relevantes que impacten en la comunidad, en la codebase y en el desarrollo, como políticas con valores sólidos y éticos, por ejemplo, la accesibilidad o la igualdad de oportunidades.

Profesionales de la dirección de equipos: qué necesitan hacer

• Añadir los objetivos organizativos y empresariales a la documentación de la codebase, por ejemplo en el README.

Profesionales del desarrollo de software y diseño: qué necesitan hacer

• Añadir los objetivos técnicos y de diseño a la documentación de la codebase, por ejemplo en el README.

Más información

• Cómo escribir objetivos de proyecto por Marek Hajduczenia.