Especificaciones de la documentación técnica
Al citar contenidos de terceros se deberá indicar la fuente.
Cuando se utilicen imágenes externas, se deberá citar la fuente debajo de la imagen o al final del texto.
Los números arábigos siempre deben estar en forma de medio ancho, no en todo el ancho.
Si el valor es superior a miles, se debe agregar un signo de mil (coma de medio ancho).
Para valores de 4 dígitos, el signo milésimo es opcional; por ejemplo, 1000 y 1000 son aceptables. Para valores con más de 4 dígitos se debe agregar el signo de mil.
La moneda debe estar en números arábigos y el símbolo de la moneda debe escribirse antes del número, o el nombre chino de la moneda debe escribirse después del número.
Para los nombres de monedas en inglés, se recomienda consultar la norma internacional ISO 4217.
Al indicar un rango numérico, utilice una línea ondulada (~) o una sola línea (—) para conectar. Consulte la sección "Hunter" de la sección "Puntuación".
Cuando hay un signo de unidad o de porcentaje, se recomienda sumar ambos números con un signo de unidad o de porcentaje.
Para aumentar un número, utilice "aumentado" y "aumentado a". "Le" significa incremento y "To" significa cantidad cuantitativa.
Para reducir números, utilice "reducir" y "reducir a". "Le" significa incremento y "To" significa cantidad cuantitativa.
No puedes utilizar la expresión "reducir N veces" o "reducir N veces". En su lugar, utiliza "reducir en un pequeño porcentaje" o "reducir en un pequeño porcentaje". Porque duplicar (o reducir) significa que el valor que originalmente era cien ahora es igual a cero.
(1) Los signos de puntuación de las oraciones chinas deben ser símbolos de ancho completo, para mantener la coherencia visual con el texto de ancho completo.
(2) Si toda la oración está en inglés, use puntuación en inglés/de ancho medio para la oración.
(3) Los puntos, signos de interrogación, signos de exclamación, comas, puntos, punto y coma y dos puntos no deben aparecer al principio de una línea.
(4) Los puntos (puntos, comas, comas, punto y coma, dos puntos) no aparecerán al final del título, ni las marcas (comillas, corchetes, guiones, elipses, marcas de título de libro, marcas de énfasis). , espaciadores, etc.) Signo de exclamación, signo de interrogación) OK.
(1) Se debe utilizar un punto de ancho completo (.) al final de una oración china.
(2) Cuando se utilizan corchetes al final de una oración, el punto debe estar fuera de los corchetes.
(1) La coma ( , ) indica una pausa general dentro de la frase.
(2) Tenga cuidado de evitar "comas hasta el final", es decir, utilice comas para todas las pausas en todo el párrafo excepto el final.
(1) Las palabras coordinadas dentro de una oración deben estar separadas por comas completas ( , ) en lugar de comas, incluso si las palabras coordinadas están en inglés.
(2) En oraciones en inglés, las palabras paralelas están separadas por comas de medio ancho (,).
(3) Para las palabras paralelas dentro de la oración china, intente usar (y) para conectar la última para que la oración se lea de manera más coherente. Las dos oraciones siguientes son aceptables, excepto la segunda. es mejor.
(1) El punto y coma ( ; ) indica la pausa entre cláusulas paralelas dentro de una oración compleja.
(1) Al citar, debe utilizar comillas dobles de ancho completo (" "). Tenga en cuenta que las comillas dobles anteriores y siguientes son diferentes.
(2) Cuando necesite utilizar comillas dentro de las comillas, utilice comillas dobles en la capa exterior y comillas simples (' ') en la capa interior. Tenga en cuenta que las comillas simples antes. y después son diferentes.
(1) Al agregar explicaciones, utilice corchetes redondos de ancho completo ( () ) sin espacios antes y después de los corchetes.
(2) Nombres chinos e ingleses de varios corchetes.
(1) Los dos puntos de ancho completo (:) se utilizan a menudo después de palabras que necesitan explicación para obtener explicaciones y explicaciones.
(2) Al expresar la hora, se deben utilizar dos puntos de ancho medio ( : ).
(1) Los puntos suspensivos (…) indican que la frase está incompleta o el modo es discontinuo.
(2) Los puntos suspensivos ocupan dos espacios de caracteres chinos y contienen seis puntos de omisión. . . o ... y otras formas no estándar.
(3) Los puntos suspensivos no deben usarse con la palabra "etc."
(1) La narración debe realizarse en un tono tranquilo y tratar de evitar el uso de signos de exclamación (!).
(2) No se permiten varios signos de exclamación, como ! ! y !!! .
(1) Dash ———— generalmente se usa para explicaciones adicionales.
(2) El guión debe ocupar la posición de dos caracteres chinos. Si el guión en sí solo ocupa el espacio de un carácter chino, entonces debe haber un espacio de medio ancho antes y después.
(1) El guión se utiliza para conectar dos palabras similares.
(2) En las siguientes situaciones, se debe utilizar un signo de conexión recto (-), ocupando la posición de un carácter de medio ancho.
(3) Los rangos numéricos (como fechas, horas o números) deben utilizar una tilde (~) o una sola fuente (—), ocupando la posición de un carácter de ancho completo.
Ten en cuenta que se recomienda sumar unidades a ambos valores antes y después de la tilde.
(4) El guión de tilde también se puede sustituir por el carácter chino "to".
Ejemplo de referencia:
El nombre del archivo del documento no debe contener espacios.
El nombre del archivo debe utilizar caracteres de ancho medio y no se permiten caracteres de ancho completo ni caracteres chinos.
Se recomienda utilizar sólo letras minúsculas en los nombres de archivos, no letras mayúsculas.
Para que sean llamativos, los nombres de algunos archivos de descripción pueden utilizar letras mayúsculas, como README y LICENSE.
Cuando el nombre del archivo contiene varias palabras, se recomienda utilizar líneas de conjunción de ancho medio (-) para separar las palabras.
/ruanyf/document-style-guide/blob/master/docs/reference.md
/ruanyf/document-style-guide
/blog/ 2017/02/filename-should-be-lowercase.html
Contenido transferido desde: /blog/2016/10/document_style_guide.html