Primeros pasos con la documentación

Acerca de la documentación

¿Qué se puede documentar?

  • Ejemplos de funciones para varios lenguajes.
  • Una breve introducción de cada etiqueta.

¿Cuál es la diferencia entre una pregunta y un tema?

  • Los temas tienen un alcance más amplio que las preguntas; Los temas de documentación que se hacen como una pregunta pueden cerrarse porque son demasiado amplios.
  • Los temas deben tener múltiples ejemplos; una solicitud que puede ser atendida por un tema con un solo ejemplo (por ejemplo, un bloque de código) probablemente sea demasiado limitada.

Hola Mundo

Un tema de hola mundo debe consistir en el programa de inicio más básico, completo y ejecutable disponible, que se puede lograr con la mayor cantidad de versiones del lenguaje, marco o sistema que se está documentando. Si es necesario, los comentarios deben incluir instrucciones básicas sobre cómo preparar y ejecutar los ejemplos.

Por lo general, el tema no debe requerir más de uno o dos ejemplos, excepto en los casos en que las versiones posteriores del idioma no sean compatibles con versiones anteriores. Recuerde, el tema hola mundo será el punto de partida para cualquier persona que esté comenzando a aprender un idioma. Como tal, debe demostrar ejemplos de trabajo mínimos que un alumno puede usar para lograr un programa correcto. No es necesariamente un lugar para demostrar las características más nuevas de un idioma.