bmiomi / soyinformatico

Documentemos la Ingeniería Informática

Proyecto Soy Informático

Documentemos la Ingeniería Informática

Un repositorio que pretende ser la guía para recordar, aprender o retroalimentar información sobre distintas áreas de la Ingeniería Informática.

Tabla de contenido

• Objetivos.
• ¿Cómo funciona?.
• Contribuir.
• Tips de sintaxis para dar formato a los README.
  • Insertar HN.
  • Cursivas.
  • Negrilla.
  • Viñetas para tablas de contenido.
  • insertar imágenes.
  • Insertar enlaces.
  • Hacer anclaje.
  • Insertar una línea de código.
  • Insertar un bloque de código.
  • Resaltar el código.
  • Insertar tablas.
  • Referencias externas sobre markdown.
• FAQs.
  • ¿Por qué debería documentar todo lo que aprendo?

Objetivos

• A largo plazo cualquiera pueda aprender de la Ingeniería Informática por medio de este repositorio.
• A medio plazo, tener información de calidad y minimalista para poder retroalimentar o recordar partes de código, definiciones y demás sobre la Ingeniería Informática.

¿Cómo funciona?

En el repositorio, las distintas áreas, campos o lenguajes de programación que se aprende en la Ingeniería Informática estan creados por carpetas, ejemplo: Java, C++, HTML, DISCRETAS, etc... Cada carpeta contiene un archivo README.md y una carpeta llamada Images. En el archivo README.md se documentará todo lo que más se pueda acerca de dicha categoría y en la carpeta Images se guardará las imágenes que se insertarán en el archivo README para explicar algo gráficamente.

El archivo README.md tiene la siguiente arquitectura de la información que deberás de tener en cuenta a la hora de colaborar ya sea mejorandolo, corrigiendo o creando uno nuevo para otra categoría aún no publicada:

• Una introducción sobre la definición de la categoría, ejemplo: Java es un lenguaje de programación, etc...

• Contribución: Recordando a las personas como pueden contribuir con el proyecto.

• Licencia: Recordando que todo artículo publicado es bajo licencia Atribución – No comercial – Compartir igual.

• Tabla de contenido [Con anclaje a cada item].

  • Tema 1: No olvidar poner referencias externas al final del item, para mostrar de donde se sacó la información o simplemente para ampliar dicha información. . . .

  • Tema N.

  • FAQs

  • Créditos: Si eres aportante, deja un enlace de reconocimiento, ejemplo: tu usuario de alguna red social, pagina web, etc...

Contribuir

Utiliza las opciones de GitHub como Pull Request o un Fork para colaborar con el proyecto:

Fork: Hace un clon de este repositorio en tu cuenta de GitHub. En el podrás hacer modificaciones o simplemente para tener una copia (con opción de clonarlo a tu PC también). De esa forma garantizas la información para tu uso personal.

Pull Request: Envía la sugerencias de cambio para este repositorio, los cuales hicistes en tu clon. Si son aceptadas por el master, se fucionan los cambios y el repositorio del proyecto queda actualizado.

Adicionalmente, se esta creando un sitio web, por ahora con el único objetivo de dar a conocer lo que estamos haciendo aquí a Universidades, foros, etc... El enlace es: wwww.soyinformatico.org

Tips de sintaxis para dar formato a los README

Los archivos README.md tienen formato de lenguaje de marcado markdown que es mucho más sencillo que el lenguaje HTML. Veamos algunos ejemplo:

Insertar HN

# Esto es un H1
## Esto es un H2
### Esto es un H3
#### Esto es un H4

Cursivas

*Esto es cursiva*

Negrilla

**Esto es negrilla**

Viñetas

- Esto es viñeta 1.
  - Viñeta 1.1 con sangria.
  - Viñeta N.
  

Insertar imágenes

![texto cualquiera por si no carga la imagen](url completa de la imagen)

Insertar enlaces

[texto a mostrar](url completa)

Hacer anclaje

Usar los títulos con la almohadilla # y para anclar el título a una tabla de contenido, ponemos lo siguiente:

[texto a mostrar](#mi-titulo-a-anclar)

Insertar una línea de código

Encerrar la linea de código entre la tilde al revez ` Código en ASCII: alt96

Ejemplo:

`tu linea de codigo`

Insertar un bloque de código

Encerrar el bloque de código entre tres tildes al revés ``` Código en ASCII: alt96

Ejemplo:

		```
		
		//bloque de codigo...
		
		```

Resaltar el código

Encerramos el bloque de código con las tres tildes al revés ``` y le ponemos al lado el lenguaje que se está usando, ejemplo:

		```java
		
		//bloque de codigo...
		
		```

Insertar tablas

| TITULO1| TITULO2|

| ----- | ---- |

| CONTENIDO COLUMNA 1 | CONTENIDO COLUMNA 2 |

Referencias externas sobre Markdown

Para mayor información sobre la sintaxis del markdown:

http://www.genbeta.com/guia-de-inicio/que-es-markdown-para-que-sirve-y-como-usarlo

https://help.github.com/articles/markdown-basics

https://guides.github.com/features/mastering-markdown/

FAQs

¿Por qué debería documentar todo lo que aprendo?

Garantizamos tener la información de nuestro conocimiento accesible todo el tiempo, con el objetivo de recordar partes de datos claves que necesitemos en futuros proyectos o simplemente retroalimentarnos de manera colectiva gracias a la facilidad de poder contribuir entre varias personas con el proyecto.