Foros del Web » Programando para Internet » PHP »

Documentar el proyecto de un sitio hecho en php

Estas en el tema de Documentar el proyecto de un sitio hecho en php en el foro de PHP en Foros del Web. Hola, estoy creando un sitio web con casi todo hecho en php, y tengo el problema que no se como documentar todo, las paginas que ...
  #1 (permalink)  
Antiguo 15/04/2005, 01:15
 
Fecha de Ingreso: abril-2005
Mensajes: 6
Antigüedad: 12 años, 8 meses
Puntos: 0
Documentar el proyecto de un sitio hecho en php

Hola, estoy creando un sitio web con casi todo hecho en php, y tengo el problema que no se como documentar todo, las paginas que contiene, los links, mapa del sitio, etc, estaba pensando en UML pero es muuuuy orientado a objetos y no se adapta a mi "programación".
Bueno amigos, espero que puedan contestarme, porque ya no se me ocurre nada y me sería muy, pero muy útil.
  #2 (permalink)  
Antiguo 15/04/2005, 02:36
Ex Colaborador
 
Fecha de Ingreso: junio-2002
Mensajes: 9.091
Antigüedad: 15 años, 5 meses
Puntos: 16
Hola,

¿Quieres documentar tu web o tu codigo? es que dices
Cita:
las paginas que contiene, los links, mapa del sitio, etc
y no nombras el codigo.

Si lo que quieres es documentar la estructura web (paginas y links), he visto usar UML, usando cada pagina como una clase, y los links entre paginas como "mensajes" entre clases.

Saludos.
__________________
Josemi

Aprendiz de mucho, maestro de poco.
  #3 (permalink)  
Antiguo 15/04/2005, 11:25
 
Fecha de Ingreso: abril-2005
Mensajes: 6
Antigüedad: 12 años, 8 meses
Puntos: 0
documentar el sitio

En realidad me gustó eso de UML, el código estaría bueno documentarlo tambien ... pero es mas complicado no???. Muchas gracias!!!. Un buen software para usar el uml puede ser el uml studio no?
  #4 (permalink)  
Antiguo 15/04/2005, 12:26
O_O
 
Fecha de Ingreso: enero-2002
Ubicación: Santiago - Chile
Mensajes: 34.417
Antigüedad: 15 años, 11 meses
Puntos: 126
Antes de buscar un "software" deberías "empaparte" de toda la teoría sobre "Programación Orientada a objetos" (del cual tenemos un sub.foro en este foro de PHP para tratar esos temas).

Pero .. lo que preguntabas en principio .. como más o menos comentas, no necesitas comentar el código de forma automática para luego generar documentación sobre el código en sí: sobre funciones y sus parámetros .. sobre classes, variables, etc ...

Si hablas de generar algo tipo "help" de windows para tu documentación . .con su indice, buscador .. y demás. Podrías usar ese mismo formato o mejor todavía PDF .. ahí puedes definir indices .. hipervinculos .. etc. Ahora .. si lo que preguntas es "cómo" enfocar el diseño de ese manual .. mmm... concretalo .. pero este no es el foro adecuado (ni para una cosa ni para la otra ..).

Un saludo,
  #5 (permalink)  
Antiguo 15/04/2005, 15:56
 
Fecha de Ingreso: abril-2005
Mensajes: 6
Antigüedad: 12 años, 8 meses
Puntos: 0
Cluster, lo siento, pero por lo visto no entendiste lo que quiero hacer.
Alguien sabe de donde puedo sacar ayuda para hacerlo con UML?. Porque algo vi de UML y estuve haciendo un par de cosas, pero un refuerzo no me vendría nada mal.
Gracias
  #6 (permalink)  
Antiguo 15/04/2005, 16:35
O_O
 
Fecha de Ingreso: enero-2002
Ubicación: Santiago - Chile
Mensajes: 34.417
Antigüedad: 15 años, 11 meses
Puntos: 126
Ok . .en ese caso, haz tu pregunta en el foro de "Ingenería del Software y gestión de Aplicaciones", ahí se tratan esos temas .. Si luego buscas implementar ese tipo de patrones bajo PHP en Programación Orientada a objetos .. dispones del sub-foro de mismo nombre en este foro ..

Programar "Orientado a objetos" no es sólo llegar y meter unas funciones en una classe .. hay más "teoría" por el camino .. patrones, modelos .. etc .. En los foros mencionados tienes un tema marcado como "FAQ" ahí tienes links interesantes para que te documentes.

Un saludo,
  #7 (permalink)  
Antiguo 15/04/2005, 16:53
 
Fecha de Ingreso: abril-2005
Mensajes: 6
Antigüedad: 12 años, 8 meses
Puntos: 0
Cluster, soy licenciada en sistemas, y se de P.O.O. Me parece que estas demasiado acostumbrado a que la gente pregunte sin saber, pero te desviaste un poco...
Yo solo preguntaba como documentar un sitio web, que oohh casual lo hice en php, pero aclaré que no use clases, mas que nada porque no lo creí necesario.
En cuanto a los foros que me recomendaste, no me sirve ninguno.
Gracias igual.
  #8 (permalink)  
Antiguo 16/04/2005, 15:16
O_O
 
Fecha de Ingreso: enero-2002
Ubicación: Santiago - Chile
Mensajes: 34.417
Antigüedad: 15 años, 11 meses
Puntos: 126
Lamento que te moleste mis recomendaciones .. pero como comprenderas .. no he visto tu perfil ni sé que sabes o que no sabes ni titulación que puedas tener ... Eso debes comprenderlo .. no soy adivino.

De todas formas .. insisto que UML se trata en el foro de "Ingenería del software y gestión de proyectos" te guste o no te guste ..

Un saludo,
  #9 (permalink)  
Antiguo 16/04/2005, 16:27
 
Fecha de Ingreso: abril-2005
Mensajes: 6
Antigüedad: 12 años, 8 meses
Puntos: 0
Jajaja, Ok, gracias, lo miraré. Saludos!!!
Atención: Estás leyendo un tema que no tiene actividad desde hace más de 6 MESES, te recomendamos abrir un Nuevo tema en lugar de responder al actual.
Respuesta




La zona horaria es GMT -6. Ahora son las 18:03.