Organización y Creación de Documentos Técnicos Coherentes
Ya sabes escribir frases coherentes, puedes escribir párrafos claros y precisos. Ahora vamos a aprender a organizar todos esos párrafos en un documento coherente. Así que... here we go!
Define el alcance de tu documento 📏
Un buen documento comienza por definir su alcance. Por ejemplo:
Este documento describe cómo crear apps para Android utilizando la API del marco de trabajo de Android y otras bibliotecas de código abierto.
Estas definiciones de alcance benefician tanto al lector como al technical writer. Puede suceder que, mientras escribes, el contenido de tu documento se aleje de la definición del alcance. Lo que debes de hacer es reenfocar el documento al alcance definido o modificar la definición del alcance.
De cualquier manera, al revisar tu primer borrador puedes eliminar (o pasar a otro documento) cualquier sección que no ayude a satisfacer el alcance del documento.
Define a tu audiencia 👩👩👧👦
Un buen documento especifica explícitamente su audiencia y cualquier conocimiento o experiencia previa. Por ejemplo:
Esta documentación está dirigida para los desarrolladores familiarizados con la programación en JavaScript y conocimientos de programación orientada a objetos.
Nuestros lectores son personas ocupadas que no necesariamente leerán todas las páginas de nuestro documento. Imagina que solo pueden leer el primer párrafo de la página uno. Al revisar tu documentación asegúrate de que el inicio de tu documento responda a las preguntas esenciales de tus lectores.
Los escritores profesionales concentran una energía considerable en la página uno para aumentar las probabilidades de que los lectores lleguen a la página dos. Sin embargo, la página uno de cualquier documento largo es la más difícil de escribir. Prepárate para revisar la página uno muchas veces.
Siempre escribe un resumen ejecutivo (también conocido como abstract) para los documentos largos. Aunque el resumen ejecutivo debe ser muy corto, toma en cuenta que pasarás mucho tiempo escribiéndolo. Un resumen ejecutivo aburrido o confuso es una señal que advierte a los potenciales lectores de que se mantengan alejados.
Cómo escribir para tu audiencia 🚀
A lo largo de este curso he enfatizado varias veces la importancia de definir tu audiencia. En esta sección nos centramos en la definición de la audiencia como un medio para organizar tu documento.
Preguntas para definir a tu audiencia ❓
Responder a las siguientes preguntas te ayudará a determinar qué debe contener tu documento:
¿Quién es tu público objetivo?
¿Qué es lo que tus lectores ya saben antes de haber leído el documento?
¿Qué deberían saber o poder hacer tus lectores después de haber leído el documento?
Por ejemplo, supongamos que en una organización implementarán un nuevo algoritmo de redes neuronales profundas en un programa. La siguiente lista contiene algunas respuestas potenciales a las preguntas anteriores:
Mi público objetivo está formado por científicas de datos y programadores de mi organización.
La mayoría de mi público objetivo estudió conceptos avanzados de programación, conoce la API de Keras y tienen conocimiento intermedio en Python. Sin embargo, alrededor del 25% de mi público objetivo no ha implementado un algoritmo de redes neuronales profundas directamente en un programa.
Después de leer este documento:
Los lectores tendrán una idea clara de los conceptos teóricos implicados en el desarrollo de software inteligente mediante el uso de redes neuronales profundas.
Los lectores conocerán el alcance y las mejores prácticas en el desarrollo de sistemas predictivos usando el paradigma de aprendizaje profundo, así como los beneficios implicados en su desarrollo.
Los lectores serán capaces de desarrollar soluciones para problemas de alta complejidad mediante el diseño, construcción, validación e implementación de modelos de redes neuronales de alto desempeño.
Cómo organizar la estructura de tu documento 🏗
Después de definir tu público, organiza el documento para proporcionar lo que los lectores deben saber o ser capaces de hacer después de leer el documento. Por ejemplo, el esquema del documento podría ser el siguiente:
Introducción a la Inteligencia Artificial y al Aprendizaje Profundo
1.1. Entendiendo las Redes Neuronales y el Aprendizaje Profundo.
1.2. Desarrollo de Redes Neuronales en Python.
Fundamentos de Aprendizaje de Máquina
2.1. Ramas de Aprendizaje de Máquina.
2.2. Librerías para Aprendizaje de Máquina en Python.
Variantes de Redes Neuronales
3.1. Variantes de Redes Neuronales y sus Fundamentos.
3.2. Arquitectura de una Red Neuronal de Visión Artificial.
Ejemplos de Aplicaciones Modernas usando Aprendizaje Profundo
4.1. Generación de Textos Usando Redes Neuronales Recurrentes.
4.2. Modelos de redes neuronales para generar datos.
Además, ten en cuenta la segmentación de tu público para darle un enfoque correcto a tu documento. Por ejemplo, el público objetivo estudió Python, pero aproximadamente una cuarta parte de tu público podría no recordar los detalles de la API de Keras. Por lo tanto, es probable que en el documento insertes referencias a documentación externa de la API en lugar de intentar explicarla.
Documentación modular: divide tu tema en secciones 🔪
La programación modular se divide en archivos, clases y métodos. El código modular es más fácil de leer, entender, mantener y reutilizar. Hacer que nuestros documentos sean modulares nos da los mismos beneficios. Si eres programador, probablemente tengas una fuerte familiarización con la modularidad funcional en el código, pero ¿cómo usarías estos principios en tu escritura?
Imagina que tienes una bodega vacía en la que necesitas guardar un lote de cajas grandes, medianas y pequeñas. ¿Cómo planearías meter las cajas para asegurarte de que todas podrán entrar en la bodega? Por supuesto que primero meterías las cajas grandes, luego las medianas y finalmente las pequeñas. Si intentaras hacer esto en el orden contrario, fallarás.
La cabeza del lector se parece mucho a una bodega vacía. La información generalmente se acomoda en su cerebro en tres tamaños: grande, mediana y pequeña. Los tamaños de la caja son el tamaño de la información. Necesitas acomodar cada caja dentro del espacio de la cabeza de nuestro lector para que procese y entienda nuestros escritos.
Para decidir el orden de esta información y saber el orden en que debemos de escribirla puedes usar la estrategia de grabarte a ti mismo hablando (o escribiendo libremente) sobre algún tema durante un corto período de tiempo, pueden ser 2 a 5 minutos. Sé específico en tu explicación. Inténtalo varias veces hasta que seas capaz de entenderte a ti mismo y te parezca coherente.
Lo sé, esto requiere disciplina, pero es una herramienta infalible para comunicar la información de manera modular.
¿Pondrás en práctica estos ejercicios? 🔥
Antes de avanzar a la siguiente clase debes completar los siguientes 2 desafíos.
:one: Escribe una documentación para principiantes sobre cómo conectar un celular vía USB a tu computadora.
:two: Escribe la documentación de un programa o función que hayas escrito por tu propia cuenta (en cualquier lenguaje de programación). Imagina que quieres convertir tu proyecto en open-source y estás escribiendo esta documentación para que otras programadoras entiendan tu programa y puedan ayudarte a escalarlo.
Recuerda poner en práctica lo que aprendiste en esta clase. Debes definir el alcance, audiencia y puntos clave de tus documentos.
¡Cuéntame en la sección de comentarios cómo te fue! En la siguiente clase aprenderemos cómo utilizar Markdown para escribir nuestra documentación. ✍
Está genial tu documentación Juan Esteban :fire: :muscle: muy clara y precisa.
Aguante Notion 💯👌😁
¿Cómo conectar tu celular a tu pc con el cable USB?
Esta explicación puede ser usada por cualquier persona sin habilidades técnicas y describe cómo conectar un celular a una pc con el cable USB.
++Pasos:++
Identifica en el cable USB los dos extremos.
Sin forzar la conexión conecta el extremo más grande (USB tipo A) en tu computadora.
<Foto>
Conecta el otro extremo del cable USB en la ranura de tu celular que corresponda con la forma de la conexión, igualmente sin forzar.
Verifica en la pantalla de tu celular si se conectó correctamente a la computadora.
En tu celular debería salir en pantalla los permisos y el tipo de conexión que quieras establecer entre el celular y la computadora.
Documentación de código
Va sin acentos para evitar rollos y coloqué sólo la documentación de una clase porque el código es muy largo.
classBorracho:"""
Es una clase que representa a un hombre que camina random(borracho)Atributos:init_position: list
Es un par ordenado de la forma [x,y] que representa la posición inicial
position: list
Es un par ordenado de la forma [x,y] que representa la posición actual del borracho
collide: int
Es la cantidad de choques que ha tenido el borracho
board:BoardEs un objeto de clase Board que representa en qué mundo se mueve este borracho
Metodos:clearcollide()Hace que el atributo collide sea 0clearposition()Hace que el borracho vuelva a su posicion inicial
dist()Calcula la distancia euclidiana recorrida por el borracho
move()Hace que el borracho se mueva de forma random por el board
"""
def __init__(self,position,board):""" Parametrosposition: list
Es un par ordenado de la forma [x,y] que representa la posición inicial
board:BoardEs un objeto de clase Board que representa en qué mundo se mueve este borracho
"""
self.init_position=position
self.position=position
self.collide=0 self.board=board
def clearcollide(self):""" Hace que el atributo collide sea 0 """ self.collide=0 def clearposition(self):""" Hace que el borracho vuelva a su posicion inicial """ self.position=self.init_position def dist(self):""" Calcula la distancia euclidiana recorrida por el borracho
Return float
"""
x = self.init_position[0]- self.position[0] y = self.init_position[1]- self.position[1]return((x**2)+(y**2))**0.5 def move(self):""" Hace que el borracho se mueva de forma random por el board """ myrandom = random.choice(["left","right","up","down"])if myrandom =="left":if self.position[0]==0: self.collide+=1else:if self.board.crush(self.position[0]-1,self.position[1]): self.collide+=1else: self.position[0]-=1 elif myrandom =="right":if self.position[0]==len(self.board)-1: self.collide+=1else:if self.board.crush(self.position[0]+1,self.position[1]): self.collide+=1else: self.position[0]+=1 elif myrandom =="up":if self.position[1]==len(self.board)-1: self.collide+=1else:if self.board.crush(self.position[0],self.position[1]+1): self.collide+=1else: self.position[1]+=1 elif myrandom =="down":if self.position[1]==0: self.collide+=1else:if self.board.crush(self.position[0],self.position[1]-1): self.collide+=1else: self.position[1]-=1
Ejercicio:
Desafío 1: Documentación para principiantes sobre cómo conectar un celular vía USB a tu computadora.
Título: Guía para conectar un celular vía USB a tu computadora
Introducción:
Conectar tu celular a tu computadora mediante un cable USB es una tarea sencilla que te permite transferir archivos, cargar tu dispositivo y realizar diversas acciones de sincronización. En esta guía para principiantes, aprenderás cómo conectar tu celular a tu computadora de manera segura y sin complicaciones.
Requisitos previos:
Un celular con cable USB.
Una computadora con un puerto USB disponible.
El cable USB que se ajuste al puerto de tu celular.
Pasos para conectar tu celular vía USB a tu computadora:
Encuentra el puerto USB en tu computadora: Busca los puertos USB en tu computadora. Generalmente, se encuentran en los lados o en la parte trasera del dispositivo. Pueden estar etiquetados con el ícono de USB.
Conecta un extremo del cable USB a tu celular: Localiza el puerto de carga de tu celular y conecta un extremo del cable USB en él. Asegúrate de que el cable encaje correctamente y esté firmemente conectado.
Conecta el otro extremo del cable USB a tu computadora: Toma el extremo restante del cable USB y conéctalo al puerto USB de tu computadora. Nuevamente, asegúrate de que el cable esté bien conectado.
Confirma la conexión en tu celular: En tu celular, es posible que se muestre una notificación o una opción para seleccionar el tipo de conexión USB. Dependiendo de tus necesidades, puedes elegir la opción de "Transferencia de archivos" para acceder a los archivos de tu celular desde la computadora.
Accede a tu celular desde la computadora: Una vez que tu celular esté conectado y configurado correctamente, podrás acceder a él desde tu computadora. Abre el Explorador de archivos en Windows o el Finder en macOS, y verás tu celular como un dispositivo externo. Desde allí, podrás copiar, mover o eliminar archivos según sea necesario.
Finalización y desconexión: Una vez que hayas terminado de usar tu celular con la computadora, es importante desconectarlo de manera segura. En Windows, haz clic derecho en el ícono del dispositivo en el Explorador de archivos y selecciona "Expulsar" o "Extraer hardware de forma segura". En macOS, arrastra el ícono del dispositivo a la Papelera para expulsarlo.
Hola, Jeisson.
Cómo estás? Espero que bien!
Como parte del reto de la clase 17, elegí leer tu aporte y proporcionarte un feedback constructivo. Espero que te sea de ayuda.
Para comenzar, debo decirte que me gusta la forma en la que escribís, ya que podés retener efectivamente la atención del lector y vas directo al grano.
Por otro lado, en este caso particular, ir tan directo al grano puede ser contraproducente; tené en cuenta que tu público objetivo son principiantes.
Para que veas esto mejor, te doy unos ejemplos:
Al inicio cuando detallas los requisitos le explicas al lector que tiene que tener una computadora con "un puerto USB disponible". Debés tener en cuenta que si tu lector necesita acudir a esta documentación, probablemente no sepa realmente cómo se ve un puerto USB en una computadora.
Incluí imágenes que acompañen términos desconocidos para tu público objetivo tales como "ícono de USB".
Indicale al usuario que debe mantener la pantalla del celular desbloqueada para mantener la conexión con la computadora activa.
En resumen, tenés muy buena capacidad de síntesis, y si la acompañas con una mayor atención a detalles importantes como el tipo de texto que estás escribiendo y a quién va dirigido, seguramente vas a poder crear documentos técnicos altamente efectivos.
Espero que mi retroalimentación te haya sido de ayuda!
Saludos,
Facundo.
Reto 1
Como conectar un celular via USB a tu computadora
Requisitos
Celular smartphone con entrada
Tipo C o
Tipo OTG
Cable compatible con tu celular
Tipo C a USB o
Tipo OTG a USB
Computadora con entrada USB
Pasos para conectar
Prende la computadora
Verifica que el celular tenga suficiente bateria, de preferencia arriba de 30%
Conecta la entrada Tipo C o OTG al celular
Conecta el puerto USB a la computadora
Revisa que en tu computadora te indique que se encontro dispositivo
Reto 2
/**
* @description : Servicio REST que envia información a pagina web
* @author : erika.villanueva@salauno.com.mx
* @group : Digital Grow
* @last modified on : 23-01-2021
* @last modified by : erika.villanueva@salauno.com.mx
* Modifications Log
* Ver Date Author Modification
* 1.0 01-22-2021 erika.villanueva@salauno.com.mx Initial Version
**/@RestResource(urlMapping ='/Service_Website')global with sharing classService_Website{ @HttpPost global staticvoidService_WebsiteLoginPacientesGet(){// Obtiene el JSON recibido por el servicio POSTRestRequest rest_Request =RestContext.request;String respuesta_Body = rest_Request.requestBody.toString();// Convierte Json recibido a Wrapper Wrapper_PeticionWeb wrp_PeticionWeb =(Wrapper_PeticionWeb)JSON.deserialize(respuesta_Body,Wrapper_PeticionWeb.class);// Obtiene la información solicitada por servicio POSTSObject resultado =get_InformacionSolicitada(wrp_PeticionWeb);envia_Resultados(resultado);}// Envia respuesta a servicio POSTprivatestaticvoidenvia_Resultados(SObject resultado){RestResponse respuesta =RestContext.response;if(respuesta ==null){ respuesta =newRestResponse();RestContext.response= respuesta;} respuesta.responseBody=Blob.valueOf(JSON.serialize(resultado));}// Dependiendo los parametros recibidos por el servicio POST obtiene la información a enviarprivatestaticSObjectget_InformacionSolicitada(Wrapper_PeticionWeb wrp_PeticionWeb){String str_Query ='SELECT Id, Name FROM '+ wrp_PeticionWeb.objeto+' WHERE id = '+wrp_PeticionWeb.id_Registro;SObject obj_Dinamico =Database.query(str_Query);return obj_Dinamico;}// Valida que el Json recibido contenga las variables correctas global classWrapper_PeticionWeb{publicString id_Registro {get;set;}publicString objeto {get;set;}}
++Ejercicio 1++
++Ejercicio 2++
<!DOCTYPE html><html><head><title>NumeroMayor condicional</title></head><body><center><script type=“text/javascript”>/**
* [Determinar mayor de 2 numero]
* @param{[var]}numero01 [Numero uno a comparar]
* @param{[var]}numero02 [Numero dos a comparar]
* @param{[int]}numero01 [Numero uno a comparar casteado entero]
* @param{[int]}numero02 [Numero dos a comparar casteado a entero]
*/var numero01;var numero02;numero01=parseInt(prompt(“Ingrese el numero 1”,""));numero02=parseInt(prompt(“Ingrese el numero 2”,""));if(numero01 >= numero02){//imprime numero mayordocument.write(“El numero mayor es:" + numero01 + "(Numero1)”);}else{//imprime numero mayordocument.write(“El Numero mayor es :" + numero02 + "(Numero2)”);}</script></center></body></html>```
Super, muy bien explicado.
Está muy bien, felicidades
Guía para Conectar un Celular Vía USB a Tu Computadora
Conectar tu celular a la computadora vía USB es un proceso sencillo que te permite transferir archivos, realizar copias de seguridad y utilizar el celular como un módem o una unidad de almacenamiento. Sigue estos pasos para conectar tu celular de manera correcta:
Paso 1: Preparar los Elementos Necesarios
Celular: Asegúrate de que tu celular esté encendido y cargado.
Cable USB: Utiliza el cable USB original o uno compatible con tu celular.
Computadora: Enciende tu computadora y asegúrate de tener un puerto USB disponible.
Paso 2: Conectar el Cable USB
Inserta el Cable USB en el Celular: Conecta el extremo más pequeño del cable USB al puerto de carga de tu celular.
Conecta el Cable USB a la Computadora: Inserta el otro extremo del cable USB en un puerto USB disponible en tu computadora.
Paso 3: Configurar el Celular para la Conexión USB
Desbloquear el Celular: Asegúrate de que la pantalla de tu celular esté desbloqueada.
Seleccionar el Modo de Conexión: Al conectar el celular, aparecerá una notificación en la pantalla preguntándote qué tipo de conexión deseas establecer. Las opciones más comunes son:
Transferencia de archivos (MTP): Permite transferir archivos entre tu celular y la computadora.
Solo carga: Solo carga la batería del celular sin transferencia de datos.
Compartir conexión: Permite usar el celular como un módem para acceder a Internet.
Elegir Transferencia de Archivos: Selecciona "Transferencia de archivos (MTP)" para poder acceder a los archivos de tu celular desde la computadora.
Paso 4: Acceder a los Archivos del Celular en la Computadora
Abrir el Explorador de Archivos: En tu computadora, abre el explorador de archivos (Windows) o el Finder (Mac).
Localizar el Dispositivo: En la lista de dispositivos conectados, busca el nombre de tu celular. Puede aparecer como un dispositivo extraíble o con el nombre del modelo de tu celular.
Navegar por las Carpetas: Haz clic en el dispositivo para abrirlo y navegar por las carpetas de tu celular. Ahora puedes copiar, mover o eliminar archivos según sea necesario.
Paso 5: Desconectar el Celular de Manera Segura
Cerrar Archivos Abiertos: Asegúrate de que no haya archivos en uso desde tu celular en la computadora.
Expulsar el Dispositivo: En la computadora, selecciona la opción para expulsar el dispositivo de manera segura. En Windows, esto se puede hacer desde el área de notificaciones; en Mac, puedes arrastrar el icono del dispositivo a la papelera.
Desconectar el Cable USB: Una vez que el dispositivo haya sido expulsado, desconecta el cable USB tanto del celular como de la computadora.
Documentación del Proyecto: Conversor de Monedas
Descripción del Proyecto
El Conversor de Monedas es una aplicación escrita en Python que permite a los usuarios convertir cantidades de dinero entre diferentes monedas utilizando tasas de cambio en tiempo real. Este proyecto es ideal para desarrolladoras que deseen contribuir a un proyecto open-source o aprender sobre la interacción con APIs y la manipulación de datos en Python.
Características
Conversión de monedas en tiempo real utilizando una API de tasas de cambio.
Interfaz de línea de comandos fácil de usar.
Soporte para múltiples monedas.
Mecanismo de actualización automática de tasas de cambio.
Requisitos Previos
Antes de utilizar el Conversor de Monedas, asegúrate de tener los siguientes requisitos instalados en tu sistema:
Python 3.x
Biblioteca requests
Una clave API de un proveedor de tasas de cambio (por ejemplo, OpenExchangeRates, CurrencyLayer)
Instalación
Sigue estos pasos para instalar y ejecutar el Conversor de Monedas:
1.Clonar el Repositorio:
git clone https://github.com/tu_usuario/conversor_de_monedas.gitcd conversor_de_monedas
```2.Instalar las Dependencias:
```js
pip install -r requirements.txt```3.Configurar la Clave API:
```js
API_KEY='tu_clave_api'```Uso
Para ejecutar el programa, usa el siguiente comando en la línea de comandos:
```js
python conversor_monedas.py```Sigue las instrucciones en pantalla para ingresar la moneda de origen, la moneda de destino y la cantidad a convertir. El programa mostrará el resultado de la conversión utilizando las tasas de cambio más recientes.
Ejemplo de Uso:
```js
$ python conversor_monedas.pyIngresa la moneda de origen(por ejemplo,USD):USDIngresa la moneda de destino(por ejemplo,EUR):EURIngresa la cantidad a convertir:100100USD equivale a 85EUR```Estructura del Proyecto:
```js
conversor_de_monedas/│
├── config_example.py # Archivo de configuración de ejemplo
├── conversor_monedas.py # Archivo principal del programa
├── requirements.txt # Archivo de dependencias
└── README.md # Documentación del proyecto
```Contribuciones¡Contribuciones son bienvenidas! Para contribuir al proyecto, sigue estos pasos:1.Haz un fork del repositorio.2.Crea una nueva rama para tu característica o corrección de errores.3.Haz tus cambios y realiza commits descriptivos.4.Envía un pull request detallando tus cambios.
Yo creo que la analogia con el tamaño de las cajas y el tamaño de la informacion no es del todo correcta. creo que se parece mas a la profundidad o especificidad o cantidad de detalles a la hora de explicar algo. una caja grande seria una explicacion de las generalidades del sistema o accion a realizar. la idea mas principal e importante.
ejemplo:
primera caja grande: al igual que los seres humanos nos comunicamos entre nosotros, emos ideado forma de que nuestras creaciones mas complejas (computadoras) tambien se puedan comunicar entre ellas. asi pues existe una manera muy especifica de hacer que tu celular se comunique con tu pc. vamos a ver el como.
cajas medianas: cuando tu hablas con alguien el sonido necesita un medio para transmitirse, es la admosfera en que estas, asi tu cel y tu pc necesitaran un medio para poder transferir , no sonidos, sino palabras digitales. el estandar es conocido como cable usb.
segunda caja mediana: la entrada para conectar el usb a tu computadora es bastante estandar asi que ser a practicamente la misma en cualquier pc, sin embargo para tu celular no. asi existen varios tipos de entradas que dan nombre a los tipos de cable, los mas conocidos son tipo c y los tipo B.
caja pequeña: asi como tenemos diferentes lenguajes , con diferentes reglas gramaticales, y diferentes medios (audio ,visual ,escrito, corporal) en cuestion de maquinas se inventaron los protocolos que estan en funcion de que tipo de informacion se va a comunicar, y define el como se hara en terminos "gramaticales" donde la unidad minima es el bit. para el caso de tu celular estan los mas conocidos:
+ MTP(Media Transfer Protocol) transfiere archivos multimedia unicamente
+PTP(photho Transfer protocol): Optimizado par atransferir fotografias
+Transferencia de archivos.
asi que si quieres un paso a paso para hacer que tu celular le hable a tu pc aca esta :
verifica que tipo de cable Usb vas a necesitar de acuerdo a tu celular
conecta tu pc a tu celular usando el cable usb
puede que en cuanto conectes tu cel al pc te aparezca el menu de protocolos de transferencia con las opciones vistas anteriormente. de ser asi escoge la que mas que te convenga. y estas listo
de no ser asi ve a configuraciones y busca conecxion USB o conexiones, o algo similar entra a este menu, y elige el modo de conexion, o el protocolo.
pd cuando me plantearon el ejercicio me parecio muy basico, como explicar como caminar, luego recorde que mis abuelos podrian necesitarlo muy seguramente , y con forme lo escribi , me di cuenta, que incluso yo tenia algunas lagunas en las cajas pequeñas xd
package com.platzi.market.mapper;import com.platzi.market.dto.CategoryDTO;import com.platzi.market.entity.CategoryEntity;import org.mapstruct.InheritInverseConfiguration;import org.mapstruct.Mapper;import org.mapstruct.Mapping;/**
* <p>Esta interfaz es un Mapper para pasar {@link CategoryDTO} a {@link CategoryEntity} y viceversa</p>
* @author Facundo Pérez Schneider
* @since 1.0.0
* @version 18/06/2023
* @see com.platzi.market.dto.CategoryDTO
* @see com.platzi.market.entity.CategoryEntity
* *///Indicamos que los @Component que se consumen para crear el Mapper son los del Spring framework.@Mapper(componentModel ="spring")publicinterfaceCategoryMapper{/**
* Método del mapper que pasa de {@link CategoryEntity} a {@link CategoryDTO} * @paramcategoryEntity Objeto de tipo {@link CategoryEntity} que queremos pasar a {@link CategoryDTO} * @return El objeto {@link CategoryDTO} * */ @Mapping(source ="categoryId", target ="categoryId") @Mapping(source ="description", target ="category") @Mapping(source ="state", target ="active")CategoryDTOtoCategoryDTO(CategoryEntity categoryEntity);/**
* Método del mapper que pasa de {@link CategoryDTO} a {@link CategoryEntity} * @paramcategoryDTO Objeto de tipo {@link CategoryDTO} que queremos pasar a {@link CategoryEntity} * @return El objeto {@link CategoryEntity} * *///Hereda el mapeo de arriba y lo invierte @InheritInverseConfiguration//Con esto estamos diciendo que no queremos aplicar mapeos para la lista de productos en CategoryEntity @Mapping(target ="products", ignore =true)CategoryEntitytoCategoryEntity(CategoryDTO categoryDTO);}
Desafío 2: Documentación de un programa o función open-source
Título: Documentación del proyecto [Nombre del proyecto]
Introducción:
¡Bienvenida al proyecto [Nombre del proyecto]! Esta documentación tiene como objetivo ayudarte a comprender el funcionamiento de este programa/funcción y cómo puedes contribuir a su desarrollo. Si estás interesada en participar en el proyecto y contribuir con tus ideas y habilidades, estás en el lugar correcto.
Índice:
Descripción general
Propósito del proyecto
Funcionalidades principales
Requisitos del sistema
Guía de instalación
Requisitos previos
Pasos de instalación
Configuración inicial
Uso del programa/funcción
Parámetros de entrada
Salida y resultados esperados
Ejemplos de uso
Arquitectura y diseño
Estructura del código fuente
Explicación de los componentes principales
Diagramas de flujo o diagramas de clases
Contribución al proyecto
Cómo realizar contribuciones
Proceso de solicitud de cambios (Pull Request)
Normas de codificación y estilo
Información adicional
El USB, del inglés "Universal serial bus" es un protocolo de comunicaciones electrónico que suele usarse en accesorios de computadoras y otros accesorios pequeños.
El USB sirve para el intercambio de datos, el desarrollo de operaciones y, en algunos casos, la carga de la batería del dispositivo o dispositivos conectados.
Para conectarlo de tu celular hacia tu computadora, sigue los pasos a continuación:
1- Enciende tu computadora y celular
2- Conecta la entrada más pequeña del cable a la parte trasera de tu teléfono y la entrada más ancha a la abertura/puerto de tu CPU o computadora portatil(verás un símbolo de USB en la abertura correspondiente)
3- Si la conexión es efectiva te notificará una ventana en tu pantalla, de lo contrario, chequea en la barra inferior de tu computadora, desplegando los íconos ocultos.
EJERCICIO #1:
EJERCICIO #2:
Este generador de contraseñas es un ejercicio del Curso básico de Python
Repositorio en GitHub
Ejercicio de documentación
Como conectar un teléfono celular a un computador.
En este documento podrás encontrar de manera fácil y sencilla como realzar la conexión de un celular a un computador, no se necesita experiencia solo siguiendo estos pasos se lograra realizar una conexión exitosa.
En primer lugar, se debe tener a disposición un cable con conexión usb desde el portátil y una entrada tipo C desde el celular (Preferiblemente el cable con el que se carga el celular)
Después se verifica que el computador y el teléfono se encuentren encendidos
Se procede a realizar la conexión donde la punta del cable USB será conectada al portátil como se muestra en la imagen
El siguiente paso será conectar la punta de conexión tipo C al celular, como se ve a continuación
Cuando se realiza este procedimiento se puede recibir en el celular la opción con la cual se procederá a trabajar la conexión desde el teléfono al computar, ya sea compartir datos, cargar el teléfono o revisar carpetas multimedia, también por parte del pc se mostrara un mensaje que reconoce el teléfono y que la conexión USB es exitosa.
Palindromo
La presente documentación va dirigido a personas que tienen conocimientos básicos del lenguaje de programación Python y funciones lambda.
Un palindromo es una palabra que, sin importar como se lea (bien sea de derecha a izquierda, como de izquierda a derecha) va a significar lo mismo:
Ejemplo:
ana,
solos.
En el siguiente código se ingresa como parámetro el texto solos con el objetivo de que si la palabra es un Palindromo, ésta devuelve ==True==, de lo contrario devulve un ==False==
Para conocer más a detalle este ejercicio, te invito a que veas la clase de funciones anónimas con el Master Facundo :wink:
¿Cómo conectar tu celular con una pc vía USB?
Este documento está dirigido a personas con poca o ninguna experiencia en el campo de la tecnología.
Requisitos:
Debes tener un computador conectado a la toma eléctrica y/o con batería cargada (este procedimiento funciona tanto para computadores portátiles como con los computadores de escritorio); para el ejercicio no vamos a tener en cuenta el sistema operativo del pc.
Debes tener un celular con su respectivo cable que viene de fábrica cuando realizas la compra del mismo. (Se recomienda el cable de fábrica, ya que existen diferentes tecnologías de cables con diferentes formas en sus extremos, los conectores).
Cumpliendo los requisitos descritos anteriormente, vamos a continuar con los siguientes pasos para alcanzar nuestro objetivo:
Conecta el extremo más pequeño del cable al celular en su respectiva ranura.
Conecta el otro extremo del cable al computador (verifica la forma de la ranura, ya que existen ranuras parecidas).
En tu computador debe aparecer un nuevo cuadro (ventana) que nos confirma que se conectó el celular correctamente al computador y posteriormente te pide unos permisos dependiendo de lo que quieras hacer en éste.
Cómo conectar un celular vía USB a tu computadora.
Esta guía se describe el procesos de como conectar tu celular a tu computadora y está dirigida a personas que tienen poco conocimiento en la manipulación de dispositivos electrónico.
Debes tener los siguientes requisitos:
Un celular.
El cable USB del celular.
Una computadora.
Para conectar tu celular al computador debe hacer los siguientes pasos:
Conectar un extremo del cable USB al celular(Donde se coloca a cargar el celular).
Conectar el otro extremo(TIPO USB) a la entrada del computador que concuerda con el aspecto físico del conector del cable.
Ir a la configuración del equipo en "Mi equipo" y corroborar que el computador reconozca el celular.
Listo tu celular ya está conectado vía USB a tu computadora.
Conexión a MySQL usando PHP
/** [Código de como hacer una conexión básica a nuestra base de datos utilizando PHP ]
@param {[string} servername [nombre del servidor]
@param {[string]} database[nombre de la base de datos]
*@param {[string} user [nombre del usuario administrador de la base de datos]
@param {[string]} password [Contraseña de la base de datos]
<?php
$servername = "localhost";
$database = "databasename";
$username = "username";
$password = "password";
// se utiliza la función de php mysquli_connect donde requiere los parametros anteriormente creados.
$conn = mysqli_connect($servername, $username, $password, $database);
// Hacemos una validación para saber si se realizó de manera correcta la conexión
if (!$conn) {
die("Connection failed: " . mysqli_connect_error());
}
echo "Connected successfully";
mysqli_close($conn);
?>
Comparto mi ejercicio número 2:
/**
* Retorna la suma de los cuadrados de dos números
*
* @param{Number} number1: Primer número a sumar
* @param{Number} number2: Segundo número a sumar
* @return{Number} La suma del primer número elevado al cuadrado más el segundo número elevado al cuadrado.
*/functionsumarCuadrados(number1, number2){return(number1 * number1)+(number2 * number2);}