Introducción al Technical Writing
¿Qué es Technical Writing? Lleva tu documentación al siguiente nivel
Habilidades para convertirte en Technical Writer
¿Conoces a tu público? Escribe específicamente para tu audiencia
Cómo entrevistar equipos de programación para recolectar información técnica
Estructura gramatical
Un repaso por la gramática básica
Uso correcto de acrónimos y abreviaturas para explicar términos desconocidos
Voz activa vs. voz pasiva: estándares y estructura de una oración
Técnicas de escritura fundamentales para documentos técnicos
Sigue las reglas de George Orwell para escribir con claridad
Uso correcto de listas y tablas para ordenar información
Tipos de párrafos y paso a paso para estructurarlos
Conceptos básicos de programación e ingeniería de software
¿Qué es programación? Evolución de la documentación y technical writing
Lenguajes de programación, tipos de datos y estructura de documentos HTML
Estándares de documentación de código
Cómo documentar una función de código
Buenas prácticas de legibilidad para código y comentarios
Organización y revisión de tu documentación
Organiza y define el alcance de tus documentos
Utiliza Markdown en documentos técnicos
Guía para revisar documentación en equipo de manera efectiva
Cómo organizar documentos largos
Diseño de documentos
Crea ilustraciones instructivas
Conclusiones
Siguientes pasos para convertirte en Technical Writer profesional
No se trata de lo que quieres comprar, sino de quién quieres ser. Invierte en tu educación con el precio especial
Antes: $249
Paga en 4 cuotas sin intereses
Termina en:
Lectura
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!
...
Regístrate o inicia sesión para leer el resto del contenido.
Aportes 25
Preguntas 0
¿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.
class Borracho:
"""
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 : Board
Es un objeto de clase Board que representa en qué mundo se mueve este borracho
Metodos:
clearcollide()
Hace que el atributo collide sea 0
clearposition()
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):
""" Parametros
position : list
Es un par ordenado de la forma [x,y] que representa la posición inicial
board : Board
Es 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+=1
else:
if self.board.crush(self.position[0]-1,self.position[1]):
self.collide+=1
else:
self.position[0]-=1
elif myrandom == "right":
if self.position[0]==len(self.board)-1:
self.collide+=1
else:
if self.board.crush(self.position[0]+1,self.position[1]):
self.collide+=1
else:
self.position[0]+=1
elif myrandom == "up":
if self.position[1]==len(self.board)-1:
self.collide+=1
else:
if self.board.crush(self.position[0],self.position[1]+1):
self.collide+=1
else:
self.position[1]+=1
elif myrandom == "down":
if self.position[1]==0:
self.collide+=1
else:
if self.board.crush(self.position[0],self.position[1]-1):
self.collide+=1
else:
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.
/**
* @description : Servicio REST que envia información a pagina web
* @author : [email protected]
* @group : Digital Grow
* @last modified on : 23-01-2021
* @last modified by : [email protected]
* Modifications Log
* Ver Date Author Modification
* 1.0 01-22-2021 [email protected] Initial Version
**/
@RestResource(urlMapping ='/Service_Website')
global with sharing class Service_Website {
@HttpPost
global static void Service_WebsiteLoginPacientesGet() {
// Obtiene el JSON recibido por el servicio POST
RestRequest 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 POST
SObject resultado = get_InformacionSolicitada(wrp_PeticionWeb);
envia_Resultados(resultado);
}
// Envia respuesta a servicio POST
private static void envia_Resultados(SObject resultado) {
RestResponse respuesta = RestContext.response;
if (respuesta == null) {
respuesta = new RestResponse();
RestContext.response = respuesta;
}
respuesta.responseBody = Blob.valueOf(JSON.serialize(resultado));
}
// Dependiendo los parametros recibidos por el servicio POST obtiene la información a enviar
private static SObject get_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 class Wrapper_PeticionWeb{
public String id_Registro {get;set;}
public String objeto {get;set;}
}
Ejercicio 1
Ejercicio 2
<!DOCTYPE html>
<html>
<head>
<title>Numero Mayor 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 mayor
document.write(“El numero mayor es: " + numero01 + " ( Numero 1 )”);
}
else
{
//imprime numero mayor
document.write(“El Numero mayor es : " + numero02 + " ( Numero 2 )”);
}
</script>
</center>
</body>
</html>```
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")
public interface CategoryMapper {
/**
* Método del mapper que pasa de {@link CategoryEntity} a {@link CategoryDTO}
* @param categoryEntity 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")
CategoryDTO toCategoryDTO(CategoryEntity categoryEntity);
/**
* Método del mapper que pasa de {@link CategoryDTO} a {@link CategoryEntity}
* @param categoryDTO 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)
CategoryEntity toCategoryEntity(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.
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:
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
def run():
palindrome = lambda string: string == string[::-1]
print(palindrome('solos'))
if __name__ == '__main__':
run()
Para conocer más a detalle este ejercicio, te invito a que veas la clase de funciones anónimas con el Master Facundo 😉
Este documento está dirigido a personas con poca o ninguna experiencia en el campo de la tecnología.
Requisitos:
Cumpliendo los requisitos descritos anteriormente, vamos a continuar con los siguientes pasos para alcanzar nuestro objetivo:
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.
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:
Listo tu celular ya está conectado vía USB a tu computadora.
@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]
<?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.
*/
function sumarCuadrados(number1, number2) {
return (number1 * number1) + (number2 * number2);
}
En este tutorial aprenderás a conectar un teléfono celular a una PC usando un cable USB. De modo que podremos pasar archivos de un dispositivo al otro. Se espera que el lector tenga conocimientos básicos en el manejo de archivos en su PC, ya que, no se profundizara en este tema. A continuación te mostramos un cable USB:
Estos se caracterizan por tener un extremo que se ve de la siguiente manera:
Este conector es llamado USB tipo A macho y la mayor parte de las computadoras tienen una entrada compatible, búscala en la tuya:
Para que la conexión funcione adecuadamente asegúrate de que el otro extremo del cable encaje perfectamente en la entrada de carga de tu dispositivo móvil. En la actualidad existen mayoritariamente dos tipos de conectores:
Una vez ambos extremos estén conectados debería salir en el dispositivo telefónico la siguiente alerta o una parecida:
Presiónala y se podrá elegir en que forma se desea conectar el dispositivo. Como el objetivo de este tutorial es pasar archivos de un dispositivo a otro utilizaras la opción file transfer:
Ya presionada la opción. En la PC debería salir el dispositivo móvil conectado. Búscalo en tu explorador de archivos:
Haciendo clic en el dispositivo podrás navegar por los archivos y carpetas de tu teléfono. Para pasar archivos de un dispositivo a otro solo será cuestión de pegar o cortar archivos de un lugar a otro.
Reto 2
/**
* Inserción de un elemento en la base de datos
* @param database Base de datos con la que estamos trabajando
* @param collection Colección donde deseamos insertar el elemento
* @param document elemento a insertar
*/
export const insertOneElement = async (
database: Db,
collection: string,
document: object
) => {
return await database.collection(collection).insertOne(document);
};
Reto 1
Guía para conectar un iPhone vía USB-C a una computadora Mac.
Esta guía esta pensado para personas que utilizan tanto un iPhone, como también un Mac con sistema operativo OSX o superior.
Requisitos necesarios:
Pasos necesarios:
Comparto mi ejercicio número 1:
<h1>Guía para conectar un teléfono a una computadora vía USB</h1>En esta guía se presentan los pasos para conectar un teléfono celular android a una computadora a través de un cable USB.
La guía está enfocada a cualquier persona que utilice habitualmente un teléfono móvil android y una computadora PC con windows o linux. No se requieren conocimientos avanzados.
Antes de comenzar asegúrese de contar con lo siguiente:
Paso 1: Conecte el lado del cable más pequeño al teléfono
Paso 2: Conecte el lado más grande del cable a la computadora
Paso 3: En las notificaciones del teléfono debe buscar la opción para seleccionar el modo de conexión entre el celular y la computadora. Hay tres posibles opciones
Debe seleccionar la segunda opción: Transferir archivos.
Paso 5: Se abrirá una ventana del explorador de archivos desde la cual podrá navegar en el almacenamiento interno de su celular y copiar archivos entre el teléfono y la computadora.
Paso 6: Al finalizar, en las notificaciones, busque el mismo listado del paso 3 y seleccione Cargar solamente. Después de esto ya puede desconectar de manera segura el cable USB.
Comparto mi ejercicio numero 1:
[Guía para conectar teléfono a computadora vía USB]
¿Quieres ver más aportes, preguntas y respuestas de la comunidad?