Convenciones para la documentación en este wiki

Cada persona escribe de manera diferente y tiene prioridades únicas, acordar unas convenciones para escribir una documentación va en contra de esa condición humana, sin embargo, estamos en la búsqueda de hacer una información usable, no solo por humanos, sino por una futura API 1)API (Interfaz de programación de la aplicación), entonces tener convenciones se nos hace urgente para poder tener una documentación legible por humanos pero a su vez compatible con un sistema que pueda escalar de tamaño y ser consultado por programas.

Hay unos niveles principales: Fundamentación, Cursos disponibles, Desarrollos, Investigación

Cada temática contiene siempre un espacio de nombre (namespace) llamado start que funciona como índice, de ahí para abajo se estructura así:

divulgacion

practicas

rutinas

profundizacion

investigacion

Nota: Los namespaces (textos de la url) van sin tildes y en minúsculas, la “ñ” se cambia por n, para los espacios se usa el guión bajo.

start

Es el documento de llegada y debe darle opciones al navegante, de ser necesario puede ir acompañado de un corto párrafo de contextualización.

divulgacion

Es un texto que puede ser comprendido por alguien que nunca ha conocido la temática, se extiende máximo en dos páginas, introduce al lector con los tres aspectos principales de la temática, contiene anécdotas, datos insólitos, opiniones, es de lectura liviana. Para encontrar los tres aspectos que pueden servir en este texto nos podemos preguntar lo siguiente “¿Cuáles serían tres aspectos que hacen que una persona sea experta en esta temática?”

practicas

Serie de ejercicios para quien ya sabe algo y quiere aprender practicando con retos, Las prácticas deben ir organizadas según los Elementos Compositivos.

rutinas

Para alguien que domina el tema y quiere tener rutinas de estudio diarias para elevar su nivel. También deben ir organizadas según los Elementos Compositivos

herramientas

Colección de atajos, hojas de pastel, links de referencia, documentación de referencia rápida, scripts y otro tipo de ayudas para hacer más ágil y/o eficiente las labores con la materia.

ciclos

Desarrollo de la temática basada en ciclos