Al no asumir que la persona que mira su documento sabe todo lo que sabe … Esto le da un punto de partida para decidir quién es el público objetivo de su documento.
¿Qué requisitos previos de conocimiento se requieren para comprender su documento?
Enumere eso al comienzo del documento.
Trate de no abrumar al lector con mucha jerga. Escribe en palabras simples y mantenlo recto.
- ¿Puedo ser programador a los 28 años?
- ¿El Downtown Mountain View o el Downtown Palo Alto son más interesantes para un pasante de verano?
- ¿Cómo puede un estudiante de ingeniería informática de segundo o tercer año de una universidad promedio obtener una pasantía en grandes empresas de TI?
- ¿Qué es mejor en términos de conseguir un trabajo en Silicon Valley: obtener un título en informática o graduarse de un campamento de programación?
- ¿Necesita un título en informática o informática (o incluso cualquier título) para trabajar como desarrollador / ingeniero de software para el gobierno de EE. UU. O una gran empresa tecnológica?
Cada vez que adquiría conocimiento a través de una forma de trabajo mal documentada, después de leer mucho contenido con temas básicos y avanzados, no siempre en el mismo orden, siempre deseaba que el contenido estuviera organizado de una manera que hubiera facilitado las cosas. para mí aprender y solía terminar con la opinión de que si tuviera que volver a documentar todo el asunto, así es como diseñaría el contenido.
Entonces, en mi experiencia, a medida que avanzas en la lectura de muchas cosas y aprendes a través de ellas, desarrollas un mapa mental de elementos básicos y conceptos avanzados sobre un área de trabajo.
Restablezca su mente al estado en el que se encontraba, antes de adquirir todo ese conocimiento que está tratando de documentar. Ahora, organice todo ese conocimiento en pasos simples e incrementales introduciendo todos los temas nuevos, primero conocidos como bloques de construcción y luego profundizando lentamente en temas individuales / temas avanzados.
Para agregar una de mis experiencias personales:
Una vez compré un teléfono inteligente, un Motorola Droid Pro, hacia fines de 2012 (¡no me pregunten por qué!). Ya habían pasado 2 años desde que se lanzó. Tenía una gran cantidad de bloatware que ralentizaba el teléfono y también quería actualizar el teléfono a un sistema operativo Android más reciente. Trabajando a través de los blogs, me di cuenta de que la única forma de lograrlo era enraizándolo. Había leído tantos blogs y foros y ni siquiera había un lugar donde pudiera encontrar instrucciones detalladas paso a paso para que un principiante hiciera todo. Todos los blogs suponían que yo sabía rootear o flashear o tenía algún conocimiento de Android. Entonces, eso me molestó. Traté de organizar todo el conocimiento que reuní y escribí una sola página al respecto. Está disponible y disponible aquí: Rooting Droid Pro (GB 2.3.4 y Sys Ver 4.7.3.XT610.Verizon.es.US)
En pocos días, cualquiera que quisiera rootear un droid pro comenzó sin conocimiento previo de rooting comenzó a referirse a mi blog. Hoy, tengo un total de páginas vistas de 13.5k desde el momento en que publiqué la página. Eso es 500 visitas por mes para un teléfono que tiene más de 5 años a partir de hoy.
Y leer mucha documentación sobre si bueno / malo le da una perspectiva sobre cómo escribir buena documentación.
Por último, había intentado documentar de esta manera durante toda mi carrera como desarrollador / líder.
¡Espero que esto ayude!