Saltar a contenido

Normas de escritura de documentos técnicos

Como todos sabemos, tener una presentación con estilo uniforme y una gramática adecuada puede hacer que un artículo sea más fácil de leer y reducir los costos de comunicación.

Estructura del artículo

Al redactar artículos técnicos, se puede seguir la siguiente estructura:

# Título del artículo

Una o dos frases que introducen el contenido del artículo.

## Efecto

Por favor, describa brevemente cómo se utiliza el demo y muestre el efecto.

## Principio

Por favor, explique el principio paso a paso.

## Resumen

Haga un resumen breve.

## Referencias y agradecimientos

- [Referencia 1](enlace de referencia 1)
- [Referencia 2](enlace de referencia 2)

Normas de formato

Párrafos

  • Al utilizar la sintaxis de Markdown, no es necesario sangrar la primera línea.
  • Debe haber una línea en blanco para separar los párrafos.

Escenarios que requieren espacios

  • Entre el chino y el inglés, y entre el chino y los números:

    Incorrecto: Qt生成器是一个针对C++的跨平台IDE
    Correcto: Qt 生成器是一个针对 C++ 的跨平台 IDE

  • Entre los números y las unidades (excepto entre los números y el signo de porcentaje):

    Incorrecto: 其频率为 72MHz，占空比为 50 %。
    Correcto: 其频率为 72 MHz，占空比为 50%。

  • Entre el texto normal y los caracteres especiales (enlaces, negritas, cursivas, etc.):

    Este texto utiliza un estilo en negrita. Por favor, haga clic aquí para suscribirse.

  • Después de los signos de puntuación en inglés:

    Hello, world

  • Entre el chino y el guion:

    Markdown - una forma eficiente de escribir

Estilo de texto

  1. Al combinar chino e inglés, se utilizan los signos de puntuación chinos de ancho completo de forma predeterminada.
  2. Si hay una oración completa en inglés, se utilizan los signos de puntuación en inglés de ancho medio dentro de esa oración.
  3. Los enlaces en línea se suelen mostrar en negrita para mejorar la legibilidad.
  4. Utilice términos técnicos precisos:

    Incorrecto: usar github para iniciar sesión
    Correcto: usar GitHub para iniciar sesión

  5. Utilice comillas angulares chinas en lugar de comillas normales:

    Incorrecto: El equipo de robots de HGU, también conocido como "Wild Wolf Team"
    Correcto: El equipo de robots de HGU, también conocido como «Wild Wolf Team»

  6. No repita el uso de signos de puntuación para enfatizar.

Estilo de escritura

  • Si no es necesario, no agregue entidades innecesarias.
  • Para mejorar la legibilidad, evite el uso de oraciones largas y divídalas en oraciones más simples.
  • Los argumentos deben estar respaldados por evidencia, evite simplemente exponer teorías sin ejemplos.

Referencias y agradecimientos

Dirección original del artículo: https://wiki-power.com/
Este artículo está protegido por la licencia CC BY-NC-SA 4.0. Si desea reproducirlo, por favor indique la fuente.

Este post está traducido usando ChatGPT, por favor feedback si hay alguna omisión.