Technical Writing for Business People

Technical Writing is….

A bored activity for developers if they don’t know how to do it, but is needed, for business people is only a requirement and I think they don’t consider the real value of a good documentation.

When I stared my career as developer, I’ve used to take a look of the source code in every project, because I think the it is like a peace of art, you can see inmediatly if it is well architected and what patterns are implemented.

That was the way that I have learned to read the source code, but after many years in this industry, I understand that is the same with the documentation, it is very important to learn how to use it, it is part of that peace of art.

In this book has some obvious recomendations about techincal writting that I have already know, but I’ve consider that it is a good option if you want to improve your writting skill to create a good documentaion.

Here are some of my favourites highlights that I would like to share:

• Identify your audience and scope
• Don’t start writing until you know exactly who you’re gointg to writing for
• Always ask your self ‘what is exactly that the reader is trying to do or achieve here?’
• Give what the reader need and exactly when they need it
• Don’t use complex jargon or acronyms unless you’re absolutely certain that your audience will immediately understand them
• Never assume your readers have the same physical abilities you do
• Use measurable quantities wherever possible or appropriate
• Your reader should never have to Google to understand your writing (I’m partialy agree with this)
• Humour and geographical or cultural references are best avoided
• Avoid the passive voice and weak verbs, use active voice instead
• Keep your language as clear as possible
• Use lists to break up forbidding blocks of text
• Don’t assume you can use a graphic or image from the internet for free
• keep your writing interesting is to vary the length of sentences, a good sentence is around 15 to 25 words long
• Breaking big projects into chunks makes them less intimidating
• Delivering the finished project isn’t the end of the job

Final thought, I have spent more time documenting than coding, but I learned more documenting than coding in all my career. But I really enjoy coding than documenting.

Bye!

La revolución de la glucosa – Jessie Inchauspé

El libro menciona básicamente que muchos de los problemas o síntomas que sufren hoy muchas personas, como dolores de cabeza, cambios de estados de ánimo, somnolencia después de comer, cambios hormonales (como variación en la regla), acné, sobrepeso, inflamación crónica, cardiopatías, diabetes, diabetes gestacional, Alzheimer, etc., son algunos de los padecimientos que pueden estar relacionados con los picos de glucosa generados por los alimentos que consumimos, ya que alteran el régimen glucémico en el cuerpo.

La autora comparte algunos «trucos» que ejemplifica con testimonios de algunas personas que se han beneficiado de sus consejos, por mencionar algunos:

• Cambiar el orden en que consumimos los alimentos (primero la fibra, proteínas, grasas, carbohidratos y azúcares, en ese orden)
• Agregar una entrada de verduras antes de cada alimento (altos en fibra)
• Vigilar los alimentos con alto índice glucémico en lugar de contar calorías
• Evitar en el desayuno alimentos que provoquen un pico de glucosa (comer algo salado en lugar de dulce para el desayuno)
• Aceptar que cualquier tipo de azúcar puede generar picos (incluida la fruta natural)
• Consumir vinagre de manzana diluido en agua
• Hacer un poco de ejercicio después de comer (caminar)
• Preferir algo saldo de postre en lugar de algo dulce
• Comer fibra y proteína antes de consumir carbohidratos y azúcares

En concreto, me ha resultado bastante interesante porque explica de una forma muy simple la manera en cómo procesamos la glucosa en el cuerpo con sus efectos, y sobre todo porque lo he asociado con el libro La dieta del metabolismo acelerado de Hailie Pobroy y Cerebro de Pan de David Perlmutter, los cuales he seguido la dieta que recomiendan cuando estoy pasado de peso y he podido recuperar un peso más saludable.

Por lo qué tengo una ligera sospecha que he experimentado picos de glucosa que me provocaban algunos malestares, como dolor de cabeza, cansancio y somnolencia después de comer, la sensación de querer comer más azúcares (galletas), los cambios en mi estado de ánimo, problemas para dormir, etc.

Puntualmente, llevo cuatro días aplicando las recomendaciones que indica y me ha sorprendido ver que en algunos casos si he notado una diferencia, por ejemplo, al final de mi comida solía tomar café con pan y ahora llego satisfecho y he podido evitarlo.

Aunque aun es muy pronto para compartir mi experiencia, seguiré poniéndolo a prueba y espero compartir algunos avances después en esta entrada. Además, prometí que este año iba a poner más atención a mi salud y espero que esto contribuya un poco más.

Ah y antes de terminar, quiero compartir la crítica que le pedí a chat GPT sobre este libro:

El libro «La revolución de la glucosa» de Jessie Inchauspé ha recibido críticas y controversias, especialmente de la comunidad médica y científica. Algunos de los principales puntos cuestionados son:

1. Falta de respaldo científico: El libro se basa en una teoría de que los carbohidratos refinados y procesados son los principales causantes de la epidemia de obesidad y diabetes, pero esta teoría no cuenta con respaldo científico sólido.
2. Excesiva simplificación: El libro presenta una visión simplista y reduccionista del metabolismo y la nutrición, sin tener en cuenta la complejidad de los procesos bioquímicos que ocurren en el cuerpo.
3. Promoción de suplementos y productos: El libro promueve el uso de suplementos y productos específicos, lo cual ha sido cuestionado por algunos como una estrategia de marketing.
4. Ausencia de menciones a la actividad física: El libro no hace hincapié en la importancia de la actividad física para el control del peso y la salud en general, lo cual ha sido criticado por algunos expertos.

En general, se ha cuestionado la rigurosidad y la validez científica de las afirmaciones y recomendaciones presentadas en el libro.

Como siempre, nunca hay que creerse todo lo que dicen, pero he podido comprobar algunos efectos y hasta hoy me han ayudado a descubrir y entender más sobre lo que pasa en mi cuerpo.

Saludos

Audio libros

Nunca me han gustado los audio libros, siento que es el camino «simplon» de abordar un libro y además no lo disfruto como si yo lo leyera… así pensaba antes de que mis días fueran tan apretados y mi tiempo reducido.

Así que decidí darle una oportunidad a los audio libros, bajé uno de youtube y para mi sorpresa ha sido muy agradable, en especial por el tipo de lectura que es más como una narración, en dos días ya llevo la mitad del libro. Creo que dejaré de ser tan cerrado en este aspecto.

El primer libro que estoy escuchando es «Padre Pobre Padre Rico» de Robert Kiyosaki, he leído otros de sus libros que me han captudaro pero por alguna razón nunca me llamó la atención el primero.

Hasta donde voy, no hay mucho que me aporte en comparación de los otros pero me divierte escuchar la narración de su juventud y las enseñanzas que recibió.

En fin, probablemente seguiré utilizando algunos audio libros hasta que tenga un respiro en mi tiempo para poder tomar un libro de vuelta.

Así que lo recomiendo para los incredulos como yo que desmeritaban este medio.

Saludos

…

God Java Developer To Great One – Jhon Arthur

He de confesar que la portada de este libro me capturo de inmediato por el título, lo siento pero fue un golpe directo para alimentar mi ego que no podía dejar pasar.

Pero si lo vemos desde esta perspectiva, te sientes como «un buen programador» y un libro te dice como volverte en «uno grandioso»es algo que no pude evitar, pero tenía curiosidad por saber lo que el autor considera que un desarrollador grandioso debe tener.

Y, sin ser negativo, pienso que esté libro no aporta mucho cuando ya tienes una trayectoría porque describe (de forma sencilla) los patrones de desarrollo básicos que todo programador debería conocer, hacer o por lo menos saber que existen.

Voy a confesar que soy muy malo con los nombres de personas, de lugares o cosas, pero cuando ví los ejemplos de código me dí cuenta que había utilizado casí todos solo que  nunca supe que esa forma de programar era un patron de diseño de software.

No me siento un gran programador pero me gusta desarrollar y soy feliz por ello por hacer lo que me gusta, no me considero un experto porque el mercado de software es brutalmente cambiante, hoy puedes tener conocimiento en una tecnología y en un par de meses ya es remplazado… y me pregunto ¿cómo puedes ser grandioso en algo que cambia tan rápido? fácil, en mi opinión creo que no se puede.

Prefiero cuando la gente dice «tengo experiencia en X tecnología» a decir «soy especialista en esto…» para mí lo que te hace grande es la humildad, para escuchar, aprender y compartir.

El libro no es bueno y tampoco es malo, pero a mi me ayudo a descubrir como se llama esa forma de codificar que como buena práctica predico siempre que estoy desarrollando.

Saludos

Tú Primer Millón – Osvaldo Ramírez

Recientemente active de nuevo mi cuenta en Kindle Unlimited y me llamó la atención de este libro, el cuál, pensé que era uno de esos títulos de superación y motivación.

Sin embargo, me capturó la introducción del autor con la cual me identifique completamente y no porque el era de Ecatepec, en su lugar, me atrapó el relato ameno que el autor comenta como una charla entre amigos.

El libro muestra la corta trayectoria de Osvaldo Ramírez un empresario mexicano que relata su exeriencia en unas breves líneas donde muestra su sentir acerca que de los problemas que tuvo.

Y sobre todo la referencia y la influencia de que tuvo la obra de Robert Kiosaki sobre él  y la libertad financiera es lo que terminó por capturarme.

Es una narración muy corta pero la disfrute mucho, tiene secciones donde me identifique completamente con as experiencias que comenta el autor.

 

 

 

Antes de Renunciar a tú Empleo – Robert Kiosaki

Este libro me ha dejado mucho que pensar y estoy agradecido por haberme topado con él, hace unos meses necesitaba tomar la decisión de continuar o dejar mi empleo.

Y me llevé una gran sorpresa porque el libro habla más del emprendimiento y ahora llevo una gran reflexión sobre mi forma de vivir y el futuro que deseo.

Robert Kiosaki autor del libro Padre Pobre, Padre Rico, comparte en este título grandes puntos sobre el desemeño financiero y del pensamiento de las personas respecto a su futuro financiero, además de motivar al lector a buscar el lugar en el que desea estar. En lo personal me ha sacudido tremendamente y no puedo dejar de pensar que a mis 30 años me han educado para ser un empleado más, lo cual no es malo, pero ahora veo que el vivir de esta forma implica grandes riesgos que pueden determinar mi futuro.

El gran mensaje que me puedo llevar es e lde buscar la libertad financiera de la que tanto habla, ser más inteligente y desarrollar todas essas habilidades adicionales a mi profesión.

A veces estamos tan ocupados trabajando que no tenemos tiempo de ver otras situaciones,  y estoy convencido que las reglas de la sociedad estan a favor de la gente con dinero y aunque este no es la felicidad es una gran herramienta para alcanzarla.

En mi opinión el libro es fantastico… y a partir de esto quiero que mi vida de un gran giro.

El Cisne Negro – Nassim Nicholas Taleb

9788408008545

Este título siempre me pareció muy sugestivo y me  siento muy satisfecho de haber podido leer este libro. El conocer el concepto del Cisne Negro que describe el doctor Taleb me ha provocado un gran asombro y en algunos puntos me ha hecho sentir en shock.

Ya que hay secciones donde me ha provocado la sensación de qué lo más «normal» puede y debe ser completamente cuestionable, y solo hace falta un solo hecho para contradecirlo.

Estoy agradecido por haber recibido (de mala gana) esta recomendación en la escuela, la mejor experiencia que puedo tomar del libro es que me ha obligado a pensar desde otra perspectiva, a retar el pensamiento «normal» o «correcto», es más incluyendo las matematicas como ciencia excata, el mejor halago que podría recibir es que alguién me llame incredulo, ahora le veo mucho valor al cisne negro .

Debo reconocer que lo leei por compromiso pero al final terminé por tomarle el gusto, sin embargo en mi opinión la lectura es demasiado pesada y no es nada amigable, pero si le das su tiempo puede ser muy enriquecedor, insito a mi me ha dejado en shock porque no puedo volver a ver al entorno que me rodea de la misma forma, me tomó aproximadamente 6 meses el leer  todo el libro.

En la contraportada menciona:

Elegante, sorprendente, y con reflexiones de alcance universal, El cisne negro transformará nuestra manera de mirar el mundo.

Y lo hizo conmigo, destrozó mi realidad para después construirla con otra visión….. definitivamente es algo que recomiendo (si tienes paciencia)

Saludos

El Libro Negro del Programador (Rafael Gómez Blances)

Hace un par de semanas que terminé de leer este libro, que me ha parecido bien para tener en cuenta algunas reflexiones personales, generalmente las personas que nos dedicamos o estamos relacionados a la tecnología tenemos esa visión, como tecnologos y olvidamos el fundamento principal de nuetsra profesión, el servir.

Me gusta como aborda los temas el autor, por momentos lo siento más como un relato pero no cabe duda que si tienes tiempo inmerso en proyectos de TI más de una situación comentada te hará sentir identificado de inmediato, y hay otras que no me había percatado pero que son vicios que muchos tenemos.

Me parece una buena lectura y si la recoiendo si estas participando en proyetctos de software (con el lenguage que sea).

Estas son unos de los comentarios que me gustaron: