Documentación en Programación | Caracteristicas de buenas documentaciones de Código
Вставка
- Опубліковано 6 лют 2025
- ¡Gracias a Kite por patrocinar esta sección del vídeo! Kite es un asistente de autocompletado gratuito con tecnología de IA que te ayudará a codificar de forma más rápida e inteligente:
Haz clic aquí ➞ bit.ly/3dPzXHe ➞ para saber más.
Hace unos dias encontre un articulo interesante acerca de las caracteristicas o partes más comunes en una buena documentación cuando hablamos de programación usando Frameworks, SKDs, Bibliotecas, Lenguajes de programación o en resumen de código de terceros.
Basándome en esa guía, he creado este video con el objetivo de poder identificar buenas documentaciones y documentaciones que han faltan ser trabajadas.
Algunas de las bibliotecas y frameworks que tomares como ejemplo son:
TensorFlow (Javascript, Python)
Gin (Go, Golang)
Python
Go
Java
React (Javascript)
Vuejs (Javascript)
Angular (Javascript)
Ionic
Typescript
ENLACE DEL ARTICULO:
www.sohamkaman...
🛍 Descuentos:
NordVPN ➞ 68% de descuento en plan de 2 años ➞ Código: fazt
Hostinger ➞ 7% de descuento en cualquier compra ➞Código: FAZT
Digital Ocean ➞ Obtén 100$ gratis ➞ m.do.co/c/8ef2...
👨💻 ¿Qué servicios utilizo?
Kite ➞ bit.ly/3dPzXHe
NordVPN ➞ bit.ly/2Te7p0J
Hostinger ➞ www.hostg.xyz/...
Cloudinary ➞ bit.ly/3ohNlJ7
SiteGround ➞ bit.ly/31u9ZEk
Namecheap ➞ bit.ly/3kne9W8
🖥️ Cursos:
Curso de Python Para Principiantes ➞ • Curso Python para Prin...
Curso de Raspberry PI ➞ • Raspberry Pi, Curso pa...
Setup Visual Studio Code ➞ • Visual Studio Code, Ed...
Curso del Stack MERN ➞ • MERN STACK & Typescrip...
Curso de Typescript ➞ • Typescript | Curso Prá...
🌐 Redes:
Fazt Web ➞ www.faztweb.com/
Facebook ➞ / fazttech
Instagram ➞ / fazttech
Twitter ➞ / fazttech
Telegram ➞ t.me/fazttech
Twitch ➞ / fazttech
Slack ➞ bit.ly/3dPqCPT
Discord ➞ / discord
Blog ➞ blog.faztweb.com
📩 Contacto:
➞ fazt@faztweb.com
#docs #kite #code
La documentación es siempre importante. No sólo para otros programadores, sino también para uno mismo cuando retoma un código que escribió hace un par de meses.
Que bien que subas videos más seguido, magnífico tus consejos.
Esto es un video bastante bueno, y considero que es importante que cualquier desarrollador decente debería saber estas cosas, felicidades, hay poco contenido como este en UA-cam.
Excelente aporte Fazt, esta es una de las mayores tareas a las que se enfrenta uno cuando trabaja en un proyecto, y realmente es una tarea bastante ardua, como mencionas existen muchas documentaciones y de acuerdo a lo que necesitas tu por tu lado tendrás que hacer lo tuyo también, creando la documentación de como has implementado de tu lado el uso de una de esas librerías, framework, o porción de código, porque también tendrás que hacer que otros entiendan como lo has implementado, proque muchas también tomamos un librería, leemos un poco de su documentación, y al final puede que la implementes tal cual dice la documentación oficial, o puede que hagas una pequeña variante y eso, en el caso de que seas el programador de un proyecto empleado para una empresa, deberás dejar tu documentación bien clara, y caso contrario si eres freelancer, entonces allí puedes o no hacer aportes a la porcion de codigo, o incluso como mencionas crear un video turorial, por algunas cuestiones que no te funcionaron en el proyecto como dice la documentación y tuviste que hacer una variante. Muchas gracias por el aporte me ha servido mucho, y voy a seguir indagando. Un Saludo desde Republica Dominicana.
Comenzare a trabajar de documentadora y tú información es muy valiosa. Muchas gracias
De verdad que me emociona ver tus vídeos, cada vez se aprende aun mas.. gracias
Que tan bien está hecho el vídeo que me salió de material informativo en la clase del masterado jaja
Hola Fazt, sigo tus vídeos y me han ayudado muchísimo, sobre todo tu curso de Angular y NodeJS. Me gustaría hicieras un vídeo donde trataras el trabajo con roles de usuarios y permisos de estos desde Angular. Saludos desde Cuba. Sigue desarrollando contenido valioso que todos agradecemos.
Muy importante la documentación. Quisiera que hicieras un video explicando como documentar un proyecto, el código que escribo en los componentes, tanto para otros desarrolladores con los que pueda colaborar o recibir ayuda, así como par el yo del futuro, usando buenas practicas. Así documentar mi propio código de forma mas profesional y clara, no solo al "Como yo lo entiendo", si no siguiendo estándares! Gracias😏
Importantisimo para mi introduccion al mundo de la programacion!
Deberías crear la comunidad de Fazt, la verdad que tu contenido es único, un abrazo desde Perú 🇵🇪
Fazt ... el contenido de tu canal es sustancioso y muy bueno ... gracias por compartir ... Salu2 👍🏻
El mejor, inspirador!
Genial, la doc de Ionic es de las que más me gustan por esos ejemplos gráficos. :3
Ahora ya comprendo como diferenciar entre una buena doc y una... no tan trabajada.
Gracias n.n\
Hola Fazt, primero que nada...muchas gracias por tu contenido. Sin duda de lo mejor que hay en habla hispana. Segundo....podrias hacer un video de como implementas el testing en el front end?
Tenia la cabeza vuelta un caos. muchas gracias
Excelente video. No lo he visto pero es justo en lo que andaba buscando. Ya que creo que es importante documentar.
Muy buen video como siempre , mi documentación favorita es la de Django , tiene todas las características que mencionas en el vídeo.
Saludos desde Venezuela !
Esperaba instrucciones para redactar la documentación ya que muchos insisten en que debe incluirse un diagrama de entidad relación y casos de uso.
Sin embargo me gustó la recomendación por estudiar la documentación para bibliotecas y proyectos de terceros.
Gracias por su aporte a la comunidad . ;)
me tope con el otro canal y dije esa voz yo la conozco
EXCELENTE canal mil felicitaciones siempre con temas interezantes y muy bien explicados
Muy bueno la calidad de tus videos.
Justamente estaba mirando un video tuyo😂😂😂
Gracias Fazt!!! Consulta: ¿Qué plataforma nos puedes recomendar para documentar nuestros proyectos, al estilo de Bootstrap, Ángular, React o Vue?
Grande fazt! Esperamos más vídeos 👏🏻
excelente video, muy util, me gustaria saber sobre la documentacion tecnica, documentacion para otros programadores, como la arquitectura utilizada, la base de datos, funciones, entidades, que diagramas se usan, o que software puedo usar.
Excelente, tus videos son geniales. Gracias.
Espero y hagas un video de Redux, saludos
Genial, me resuló muy util este video!
Genial! Un tema muy interesante. ¿Te has planteado hablar de arquitectura o patrones de diseño?
Al fin un vídeos sobre esto :) SUPER GRACIAS
Buena fazt, nuevo proyecto, Crear una. Página de. Documentación
Soy estudiante en la UDGV y la verdad desde que estoy metido en el desarrollo web, siempre me ha dado curiosidad de como se documenta.
Pense que era para documentar las funciones... pero muy buen contenido igual!! gracias!
explicas que da gusto! :)
Gracias fazt por el contenido es de gran ayuda, porfa sube mas contenido de REACT gracias
Que bien. Muy bien aprovechado!!!!
Muy bueno, me gustó tu video
Gracias por tan buen contenido Fazt. Veremos alguna vez un ejemplo con Go?
Muy buenos videos, ayuda bastante a aclarar dudas y aprender cosas nuevas :D
Gracias!!!!
Muy buen video. Te felicito. Podrías explicar o darme una idea de cómo puedo realizar un programa que incluya un sistema personal extrayendo la información de una base de datos. Ej. Completar un legajo de un empleado automáticamente tras encontrar su nombre y apellido en una documentación echa con las novedades de ese día.
Muy BIEN EXPLICADO...
Gracias muy buena información
Muy buena info..... Saludos Fazt
Haras un video sobre los diferentes frameworks para crear documentación en los proyectos?
Excelente Fazt, la vida del programador incluye varias tareas y esta es una de ellas, saber documentar los proyectos. Una documentación que me ha gustado bastante es la de Nestjs muy completa y con todas esas características que mencionas. docs.nestjs.com/, gracias por compartir tus experiencias, esperamos continúes así, saludos.
Excelente contenido 👍
Hola Fazt. Que tal un video sobre servidores interesantes desde donde acceder a proyectos. Suelo cambiar de entorno de desarrollo, portatiles o sobremesa, y no se bien como tener toda la info centralizada en la nube y que se acceda facil y rapido. Tener que crear repositiorios constantemente o la lentitud de nubes como drive es desesperante. gracias
Muy bueno, pero me interesaría saber cuales son los pasos para hacer la documentación de un proyecto profesional, es decir dentro de una empresa
Fazt puedes indicar de donde sacas las imagenes para las portadas de tus temas
Pensaba que era un video sobre como escribir la documentación de un proyecto propio :( . Gracias igualemte fazt
Tengo una pregunta, se puede aprender a documentar sin tener que programar? ejemplo, quiero trabajar en una empresa de programacion pero no dedicarme a escribir codigo si no a la documentacion.
Gracias
hola , has hecho vídeos de uso de websocket en laravel?
❤️
Fazto vidio, saludos mans
Dame un me encanta Fazt
Fazt sabes de alguna comunidad donde pueda aclarar dudas o que nos apoyemos entre si? Trate de entrar a tu comunidad de slack y no pude.
Eso se hace consiguiendo compañeros en línea a dispuestos a escribir código y llevar seguimiento . Yo soy uno que me gusta compartir código Solo que me limito a lenguajes como PHP JavaScript ,Jquery y Css3. Más de hay no todavía hasta que domine modo avanzado .. estás invitado si alguno de os lenguajes que mencioné le llama la atención
cuales son los 5 conceptos de documentacion concecutia
Has una guía para documentar el código, por ejemplo como documentar una función en el mismo archivo ☹️ es lo que más me falla :(
En tu trabajo que tienes ahora y lo que sabes. Requeriste tu titulo universitario?
hola , como puedo contactarte ?
Hola, necesito comunicarme contigo mi estimado, no hay ninguna información de contacto.
Podrias subir un video de como documentar una app web
Lo siento, lo siento, en mi ultimo proyecto de la U me bajaron 20% por mi casi nula documentación. El ing me regaño bien feo por el hecho que mi proyecto no tenia ni documentación interna.
Tengo solo learn pero se me olvidan las cosas que me recomiendan para mejorar mis estudios
En mi caso escribo todas mis prácticas en repositorios y escribo documentación en el código. Aunque yo solo en las áreas que me cuesta memorizar como cuando se usa una secuencia de pasos matemáticos para llegar a un resultado. Por ejemplo en JavaScript , jQuery CSS y PHP. Por qué cuando se nos olvida nesesitamos recordar los pasos que tomamos y la razón por la que lo hicimos .
Por eso le. Recomiendo escribir los códigos en repositorios y documentarlos. Si de sea puede pasar por mí repositorio y ver ejemplos de loque yo hago ..
Lo entendí a la primera
donde encuentro buena documentacion sobre .net?
:'v yo estoy trabajando con una documentación re mala, la de Minecraft bedrock para programar Add-ons. Alternativas: comunidad (es enorme) y ver archivos internos del apk (en Minecraft bedrock movil).
Pensé que ibas a mostrar como crear tu propia documentación...hay herramientas que crean la doc basándose en los comentarios del código??
Yo solo se poner #Comentarios y Diagrama de flujo y pseudocódigo
Te amo, eres peruano?
Yo pensaba que era para hacer un anteproyecto :c
falto recomendaciones de herramientas para documentar : /
hay tropecientos videos como este, pero el de como realizar una buena documentación y que te explique como hacerlo con un ejemplo práctico nada
:D