Metasploit/GuiadeEstilo

De Wikilibros, la colección de libros de texto de contenido libre.
Ir a la navegación Ir a la búsqueda

Guía de escritura del libro de Metasploit[editar]

Al usar capturas de pantalla favor mantenerlas "limpias" y sin promociones. Los escritores tienden a insertar capturas de pantalla de sus sitios Web o banner de sus grupos de investigación. Intentar mantener todas las capturas de pantalla aburridas y genéricas para su consistencia.


Al usar capturas de pantalla intentar utilizar fondos claros con texto oscuro para todas las capturas de pantalla. Esto no es absolutamente necesario para ver mejor pero utiliza mucho menos tinta si alguien decide imprimir el contenido.


Al usar cualquier gráfico tener presente que los colores claros no imprimirán bien. Evite usar amarillo sobre un fondo blanco y evitar elementos de pantalla que cifran color cuando una descripción u otro icono bastarán. Si usted habla de como el botón verde hace una cosa y el resto hace otra, el lector estará muy confundido cuando impriman en blanco y negro. Algunos lectores daltónicos no entendarían estas referencias tampoco. (NdT: No me quedo claro este parrafo, revisar versión en Ingles)


Una captura de pantalla no es reemplazo para una explicación cuidadosa pero no hay necesidad de describir cada elemento de una captura.


Escribir como si estuvieras trabajando con el lector en la vida real. Utilice "nosotros" para representarse usted y al lector. Por ejemplo "Ahora que el buffer ha sido creado podemos utilizar este método para insertar nuestro remitente". No use "nosotros" para representarse usted y a los coautores.


Utilizar siempre el presente y la voz activa. Por ejemplo escribir "uso la opción ENCODER para especificar un payload encoder particular" no escriba "La opción ENCODER se utiliza para especificar un payload encoder particular"


Evitar el argot y lenguaje soez. Algunos usuarios no están tan actualizados como tu y pueden no entender. Peor que esto, se pueden sentir ofendidos.


Evitar las palabras y las oraciones largas. Si estás utilizando más de 3 comas en una oración, piensa una manera más corta de explicar la misma idea. Intentar mantener párrafos cortos. Sobre dos oraciones pero no más que la mitad de una página.