viernes, 14 de noviembre de 2008

¿Cómo documentar un programa de computación?


¿Qué HACE el programa, para qué sirve?

¿Qué ES el programa?

¿Cómo funciona el programa?

¿Cuales son los conceptos usados por el programa?

¿Cuáles son los temas importantes para el administrador?

¿Qué necesita saber el usuario para usar el programa?

¿Qué otras documentaciones se recomiendan?

¿Qué HACE el programa, para qué sirve?

Describir en forma breve que hace el programa, cuál es su utilidad. Poniendo enlaces a los diferentes conceptos involucrados.

Poner un tema aparte de qué hace el programa, donde la persona que quiere saber qué hace el programa pueda aprenderlo, explicando primero a grandes rasgos de qué se trata el programa y después tratando los diferentes puntos específicos relacionados al programa.

¿Qué ES el programa?

Describir el programa en si, poniendo poco interés aqui en que hace o para que sirve

Explicando cosas como:

En que lenguage esta escrito.

Cuándo se escribió, por quién, dónde.

Dónde se puede conseguir, su información relevante.

Su evolución, quiénes lo usarán, para qué, etc.

¿Cómo funciona el programa?

Aquí se trata de explicar la manera en que el programa hace las cosas pues puede haber muchas formas distintas de obtener un resultado final o de hacer algo.

También se pretende que se usen enlaces a los conceptos involucrados

¿Cuales son los conceptos usados por el programa?

En este lugar que puede ser una página aparte se pretende explicar los diferentes conceptos involucrados en el programa.

La idea es explicar con más detalle lo que significa cada cosa, poniendo ejemplos tipo metáforas que ayuden a recordar y comprender el concepto.

¿Cuáles son los temas importantes para el administrador?

Generalmente existe una persona que instala el programa, lo configura y admistra y se tendra una página separada para los temas relacionados a ese instalador y/o administrador.

Se deben incluir en esa página del administrador, cosas como:

¿Donde conseguir el programa?

¿Qué necesita tener o conseguir antes de instalarlo?

¿Cómo instalarlo?

¿Cómo configurar el programa?

¿Cómo dejarlo listo para que los usuarios o el mismo puedan usarlo?

etc.

¿Qué necesita saber el usuario para usar el programa?

Esto corresponde a lo que acostumbra llamar "manual del usuario" o guía del usuario

Aquí en esta página se pondra lo más importante para el usuario, conteniendo una "guía breve" que será como un compendio, y aparte tendra todo tipo de instrucciones para usar el programa, así como ejemplos, tutoriales y recomendaciones.

¿Qué otras documentaciones se recomiendan?

Poner enlaces a otras páginas que sean pertinentes al programa en si, o a temas relacionados o involucrados.

14 comentarios:

felipe buitrago dijo...

buenos dias profesor jorge:
el curso de introduccion al programacion ha tenido al lo largo del semestre un desempeño bueno gracias a las actividades desarrolladas en las diferentes secciones.
con las cuales estamos en la capacidad de desarrollar un problema atraves de un diagrama de flujo o en javascript. aunque debo reconocer que en mi caso aun tengo algunas dificultades en java, pero se pueden superar dando un nuevo repaso al curso on line de java.
en cunto a mi nota creo que seria un 4.0 ya que no falle a ninguna sesion, trate de cumplir a cabalidad con todos los trabajos propuestos y aprobe el primer parcial.
gracias profesor por aportar a nuestra formacion como futuros ingenieros y asi poder aportar a la sociedad.

andres alberto dijo...

profesor:
durante el curso de programacion aprindi muchas cosas que no sabia que existian como el programa de dfd, java, html,los cuales atravez de unos lenguajes podemos solucionar un problema con solo saber que es lo que se quiere teniendo una base a lo que nos dan. ademas pude conocer hacerca del mercado del software libre el cual es muy competitivo y que ya se esta aplicando en colombia y en el exterior (ORFEO)con en sistema operativo llamado linuss, entre otras cosas que aprendi en el FLISOL. debido a unas inasistencias a clases por causas que son ajenas a mi voluntad, por estar enfermo en dos ocaciones y otra por incombenientes personales, perdi un paco el hilo del curso en donde se explicaron lo del lenguaje java y los codigos de html, debido a esto se me a dificultado realizar los talleres en clase y con los trabajos donde se requieren estos lenguajes, por estas razones creo que deberia repetir el curso para que mi formación sea la mas obtima, profe si me hace el favor de no dejarmela tan bajita y gracias por su exelente educación.
nota: 2.9 o 2.8

ANDRES MAURICIO LOSADA DIAZ dijo...

PROFESOR:
INTRODUCCION A LA PROGRAMACION HA SIDO UN CURSO BUENO,YA QUE HEMOS APRENDIDO COSAS NUEVAS Y DE GRAN AYUDA A NUESTRAS CARRERAS, AUNQUE ES INDISPENSABLE DECIR QUE PARA MI CASO, EXISTEN TODAVIA ALGUNOS VACIOS EN LO REFERENTE A LA FORMACION DE CICLOS Y CONTADORES EN JAVA, LOS CUALES ESPERO SUPERAR CON UN ESTUDIO MINUSIOSO DEL MANUAL.
EL CURSO ME DIO ADEMAS LA OPORTUNIDAD DE CONOCER UN NUEVO SISTEMA OPERATIVO Y PARTICIPAR EN FESTIVAL LATINOAMERICANO DE SOFTWARE LIBRE. FLISOL

POR MI TOTAL ASISTENCIA A LAS CLASES Y LA REALIZACION DE MIS TRABAJOS PUNTUALES Y POR EL CONOCIMIENTO QUE PIENZO HE APRENDIDO CREO QUE ME CONCEPTUO CON 4.0

CESAR ANTONIO GUTIERREZ HERRERA dijo...

en la asignatura "introduccion a al programacion" me parecen una asignatura interesante y novedosa para irme a cogiendo al ritmo de los avances tecnologicos.
en el curso tube algunos incombenientes por la falta de herramientas para ejecutarlo por lo que en un periodo descuide el curso.
pero debido a la gran importancia retome los conceptos y me puse en forma con las actividades pendientes de tal forma que cada vez que lo practico, me interesa mas.
mi participacion fue buena, entrege los trabajos aunque algunos no a tiempo, mi blog esta bien documentado con fechas resientes e informacion de cada semana y mis conceptos tambien aunque me hace falta un poco para perfeccionarlo.
asisti al flisol, que fue una experiencia maravillosa y muy lucrativa para conocer nuevos caminos de obtener sofware libre, al igual que la implementacion de programas espectaculares como el "blender"

Alexander Gordillo G. dijo...

se desarrollaron unas habilidades y competencias en el uso de las herramientas de programacion basica, los conceptos básicos informática.

Estamos con la capacidad de desarrollar algoritmos y diagramas de flujo; problemas usando el dfd y el javascript.
Dado al trabajo individual, la participacion el el Flisol, el trabajo con el blogger y la nota del parcial 4.5

JORGE ALBERTO QUIZA POLANIA dijo...

este curso de programacion ha sido muy interesante porque se apredieron conceptos basicos para solucionar problemas con el computador, se aprendio como maneja la imformacion una computadora el caso de las variables y costante.
se aprendio a manejar herramientas como dfd, conceptos basicos de html y java scrip.
otro aspecto importante es la creacion del blog como herramienta para acceder a los manuales y de lecturas para soportar los conceptos vistos en clase.
CALIFICACION: 3.6

John Alex dijo...

EL CURSO DE PROGRAMACION, ME AYUDÓ A ACLARAR MUCHAS DUDAS ACERCA DEL MUNDO DE LOS COMPUTADORES Y SU PROGRAMACION EN SI. ES DIFÍCIL QUE UN TEMA TAN COMPLEJO COMO ESTOS SE PUEDA APRENDER EN TAN SÓLO 4 MESES PERO CREO QUE CON LOS CONOCIMIENTOS QUE HE ADQUIRIDO DURANTE ESTE PERIODO DE CLASES PUEDO DEFENDERME EN EL AMBITO PROFESIONAL.

BASANDOME EN EL CURSO COMO TAL, ME COSTO MUCHO TRABAJO EL MANEJO DE JAVASCRIPT YA QUE EXISTEN UN SIN NUMERO DE CODIGOS PARA TRABAJAR EN EL MISMO QUE NO LOGRE MEMORIZAR.

TRATE EN LO POSIBLE DE ESTAR ATENTO EN LAS CLASES PARA ASÍ OBTENER EL MAYOR PROVECHO DE LAS MISMAS.

MI CALIFICACION 3.6

JORGE ALBERTO QUIZA POLANIA dijo...

este curso de programacion ha sido muy interesante porque se apredieron conceptos basicos para solucionar problemas con el computador, se aprendio como maneja la imformacion una computadora el caso de las variables y costante.
se aprendio a manejar herramientas como dfd, conceptos basicos de html y java scrip.
otro aspecto importante es la creacion del blog como herramienta para acceder a los manuales y de lecturas para soportar los conceptos vistos en clase.
CALIFICACION: 3.6

Jordy dijo...

la materia de Introduccion a la prgramación ademas de aclarar ciertas dudas, enseña una manera muy dinanamica de apreciar la programacion por lascomputadoras;
como esta y muchas otras profesiones admiro todos los campos en que una persona se pueda desmpeñar.
se me dificulto un poco trabajar al ritmo que el profe nos propuso pues no manejo a la perfeccion el lenguaje de Java script, pero esto no significa que no halla puesto interes en la materia, por el contrario hay tiempo y dedicacion.
espero que sea el exigido por el docente.
NOTA:3.7

CESAR ANTONIO GUTIERREZ HERRERA dijo...

disculpe profesor pero no entendi que el comentario tocaba poner al nota.
por ello la nota se la publico en este mensaje.
CALIFICACION: 3.8

Jaime Trujillo Bolaños dijo...

Bueno este curso de introducción a la programación me pareció muy bueno ya que tendiendo en cuenta que no tenía muchos conocimientos respecto al tema, y al gran avance que personalmente he notado, en el manejo del dfd de diagramas de flujo de la solución de problemas presentándolo mas simple en un algoritmo, y el lenguaje javascript. Considero que tengo la capacidad de desarrollar un programa básico para la solución de un problema.
Respecto al desarrollo presentado en el semestre, aprobé el primer parcial,tengo el blog al dia, he entregado los trabajos, y he asistido a todas las clases, y los mas importante he aprendido.
la nota que me pondria seria un 4.5
bueno proferosr gracias por compartir sus conocimientos con nosotros

LUIS FERNANDO SALAZAR dijo...

En el curso introduccion a la programacion he tenido un avance muy significativo ya que mis conocimientos antes de ver esta materia eran nulos, a lo largo del curso aprendi a solucionar un problema mediante algoritmos y el java script, la progrmacion en la ingeniria de petroleos es muy importante ya que esta es una carrera que se basa solo en calculos debido a que el yacimiento de petroleos no se puede ver, yo se que estos conocimientos me va a servir para toda la vida, mi rendimiento en la clase fue bueno ya que cumpli con todas las actividades, asisti a clase, tengo el blog actalizado, fui a eventos extra clase tales como el flisol,pase el primer parcial, mi nota seria 4.5

NESTOR EDUARDO POLANIA VARGAS dijo...

se aprende a idntificar los diferente metodos, lenguajes y los diferentes usos de la herramientas parea la programaion, desde una programacion; partiendo desde la identificacion de un problema pasando por su descomposiocion para poder tomar plantear diferentes soluciones para luego tomar la salida mas adecuada, planteando de una manera logica y organizada(el desarrollo del algoritmo y desarrollo en dfd).
Cumpliendo los requisitos basicos eb el desarrollo, aplicacion de la prgramacion basica en el uso de diferentes operadores logicos, su uso y aplicacion en javascrpit.

El tarbajo realizdo durante las sesiones de clase en general fue bueno aunque existieron incomveniente en el desarrollo de las clases ajenos con los cuales interrumpian, por mi parte el desempeño que se realizo fue bueno, aunque la programacion no,realizaron los ejerciocios propuestos. Aunque el trabajo personal no fue el esperado, me ha servido para adquirir nuevos conocimientos. calificacion: 3.8

---PAZION 33--- dijo...

mauricio cortes muñoz
Introduccion a la progrmaacion se ha combertido en una herramienta imnovadora ya que es nuevo para mi,ha servido para que el pensamiento se desarrolle y logremos en general crear pequeños programas utilixados en nuestro diario vivir, el curso se conviertio en un aexperiencia de creacion practica, no solo teoria sino llevar esos conocimientos a un resultado, eso me parece bueno, creeo que seria mejor donde utilizaramos mas ejemplos hechos en clase utilizando todas las areas de programacion,por eso en algunas cosas no estabamos tan duchos pero en general fue espectacular,aprendi y soy conciente que participe en el momento que el profesor me pregunto y que no falle a ninguna de las clases,y trate de cumplir con los objetivos establecidos como ( creacion de blog, trabajos , publicaciones,programas etc.)mi nota seria 4.0,la ayuda del profesor fue buena todos interactuabamos


Grupo de Maperos 2011

Taller OpenStretMap Octubre 2010

Lógica Computacional e Introducción a la Programación

Libro de Lógica de Programación

Mapa

Visita Tecnológica Universidad de Antioquia

Taller de SIG Libre en Neiva Nov.28/2009

Preparese para las visitas tecnológicas 2010

Cholupa Visita Tecnológica a Medellín U de Antioquia

Registro

Lógica Computacional

Lógica Computacional