Documentation Tutorial
Empezando con la Documentación
Buscar..
Versiones
Versión | Fecha de lanzamiento |
---|---|
Beta Privada | 2016-03-26 |
1 | 2016-07-25 |
2 | 2016-08-04 |
3 | 2016-08-29 |
4 | 2016-09-12 |
5 | 2016-09-29 |
6 | 2016-10-20 |
7 | 2016-11-29 |
Acerca de la documentacion
¿Qué se puede documentar?
- Ejemplos de funciones para varios idiomas.
- 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 formulan como una pregunta se pueden cerrar 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) es probablemente demasiado estrecha.
Hola Mundo
Un tema de hola mundo debe consistir en el programa de inicio más básico, completo, ejecutable y disponible, que se puede lograr con la mayor cantidad de versiones del lenguaje, marco o sistema que se documenta. Si es necesario, las observaciones 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 apenas comience a aprender un idioma. Como tal, debe demostrar los ejemplos de trabajo mínimos que un alumno puede utilizar para lograr un programa correcto. No es necesariamente un lugar para demostrar las características más recientes de un idioma.