Guía de estilo. Regla # 1: Siga la guía de estilo. Regla # 2: Ver regla anterior.
No hay resumen de esta página. La Guía de Estilo se debe leer en su totalidad y se debe seguir. La desviación de la Guía de Estilo se debe hacer después de la discusión, permitiendo que la Guía de Estilo cambie según sea necesario por motivos prácticos.
Cuando se utiliza una Guía de estilo, el portal de documentación tendrá una única voz para el lector. Sin una guía de estilo, nuestros lectores tendrán que ajustar sus expectativas para cada documento, por lo que es una experiencia menos que ideal con posibles errores u omisiones innecesarias.
Trate de usar la menor cantidad de palabras posible y al mismo tiempo sea lo suficientemente descriptivo en sus instrucciones.
Sea específico y no omita información importante o consideración que beneficiará la decisión informada del lector
Para instrucciones de acción del usuario, ponga las palabras clave en negrita (Ejemplo: Abra Chrome, seleccione el campo de dirección en la parte superior y complete www.ether1.org)
Use texto en cursiva para nombres y referencias cortas / citas
Use tantas capturas de pantalla como sea posible para asistir visualmente su información y compagínese con la información de instrucciones de acción en negrita (consulte la guía anterior)
Use etiquetas de código triple para distinguir los comandos de la terminal, los contenidos del editor de texto y los bloques de código
Use etiquetas de código único para distinguir todo lo que encuentre necesario para destacar
Use cotizaciones de bloque para notas, comentarios y citas / referencias extensas
Cada palabra no conectiva (a menos que se use como primera palabra en el título) del Título estará en mayúscula (Ejemplo: Este es un Título de Muestra)
Cada documento comienza con un Resumen, una Introducción o una sección de Descripción que explica los antecedentes detrás del documento y / o cualquier información importante. La mayoría de la gente solo usará esta sección, necesitamos hacerlo bien.
Los títulos comienzan en el #/1er nivel.
Divida su contenido en encabezados lógicos de segundo / tercer nivel para ayudar al lector a navegar por el contenido y encontrar información útil.
Al hacer referencia a este portal de documentación, incluya siempre el enlace para facilitar su uso.
Usa buenas descripciones para tus enlaces en general.
En caso de duda, vincularlo para beneficio del lector.
Preguntas frecuentes: ¿Cómo contribuir a los documentos?
¿Me gustaría ayudar con la documentación de Ether-1?
Eso es increíble y estamos felices de tenerte! Este proyecto se basa en gran medida en la participación de personas apasionadas. Puede escribir sobre cualquier cosa relevante para las categorías generales de la izquierda. También puede mejorar y ampliar la documentación existente.
¿En qué formato debo escribir?
Asegúrate de que estás familiarizado con el marcado de reducción. Este es el formato que deberá utilizar para los envíos de documentación de Ether-1.
¿Cómo presento mi trabajo?
Puede enviar su trabajo a cualquier Community Manager (CM) o Project Manager (PM) en Discord o simplemente publicarlo en el canal # share-your-et-et-content
¿Puedo obtener una cuenta en este portal para publicar mi trabajo directamente?
Puede obtener su propia cuenta aquí después de varias presentaciones y después de haber establecido una buena relación con su punto de contacto de CM.
¿Cuánto me pagarán por contribuir a la documentación de Ether-1?
Para los nuevos artículos de documentación, se le compensará entre 75 y 250 ETHO según la longitud, la legibilidad, los detalles, la falta de errores y otros criterios del artículo. Por mejorar los artículos existentes, se le compensará entre 10 y 150 ETHO según los mismos criterios. Para traducir artículos, se le compensará entre 50 ETHO y 200 ETHO según la longitud y la complejidad.
Tenga en cuenta que todas las decisiones de remuneración finales están a criterio de su CM. Se harán todos los esfuerzos para compensar justamente a los contribuyentes. Si hay un desacuerdo entre el escritor y el CM, lleve el problema a otro CM para su revisión y resolución.
¿Cómo puedo mejorar su sistema?
Puede ponerse en contacto con cualquier miembro del equipo y plantear su idea o utilizar el canal #suggestions en Discord.
Cambiar de manera fundamental la forma en que se almacenan y entregan los archivos en Internet es una tarea enorme. Necesitamos tu ayuda para construir el futuro. Necesitamos escritores de documentación, organizadores, programadores, tecnólogos y especialistas de todo tipo. Únase a nosotros en Discord y vea cómo puede encajar en el rompecabezas de construir el futuro.
En la comunidad Ether-1 encontrará un debate constructivo que guiará el progreso, oportunidades regulares para hablar con el equipo de desarrolladores y, como ya se mencionó, encontrará múltiples posibilidades de participación. Esperamos que personas eruditas se unan a nosotros, lean sobre el proyecto (el Documento Técnico es un buen punto de partida), se comprometan con la comunidad y encuentren formas de contribuir en base a las cosas observadas. Le daremos la bienvenida a la discusión y le ayudaremos a participar.
Una buena manera de involucrarse con Ether-1 es aquí, al ayudarnos a escribir y organizar todo el conocimiento sobre el proyecto. ¡Puede obtener una compensación por hacerlo y ganar ETHO ayudándonos a todos a crecer! Consulte el artículo Cómo contribuir a los Docs y lea (y siga) nuestra Guía de estilo de Docs.