Requisitos de documentación técnica para la documentación técnica

Los documentos técnicos deben cumplir los siguientes requisitos:

1. Orientación

Antes de la preparación del documento, se deben distinguir los lectores objetivo y clasificar a los lectores de acuerdo con ellos. a diferentes tipos y niveles. Decida cómo adaptarse a sus necesidades.

① Los documentos para administradores y usuarios no deben utilizar términos profesionales de software tanto como los documentos de desarrollo (para desarrolladores de software). Para las palabras que son difíciles de evitar, se debe agregar un glosario al documento para explicarlas.

② Si ​​el vocabulario profesional utilizado en el documento de desarrollo no es ampliamente reconocido, se deben agregar comentarios para explicarlo.

③ Si la abreviatura no es ampliamente reconocida, debe ir seguida de la ortografía completa.

2. Corrección

① No hay errores tipográficos ni omisiones.

② La relación de referencia entre documentos es correcta.

③ Los detalles del documento (Título/Historial) son correctos.

3. Precisión

① El significado se expresa de forma precisa y clara, sin ambigüedad.

② Utilice los signos de puntuación correctamente para evitar ambigüedades.

4. Integridad

① El significado se expresa completamente, se pueden encontrar el sujeto, el predicado y el objeto, y el sujeto, especialmente el predicado, no se omite.

② En una oración no pueden aparecer varios verbos y un solo objeto.

③ No omitir información requerida y necesaria.

5. Simplicidad

① Trate de no utilizar oraciones largas para describir. Cuando sea inevitable, debe prestar atención al uso de la puntuación correcta.

② Sea conciso y claro, no redundante, y exprese cada significado una sola vez en el documento.

③ Cada afirmación expresa sólo un significado.

④ Esfuércese por ser conciso y, si es posible, incluya diagramas adecuados para mejorar la claridad.

6. Uniformidad

① Unificar el uso de la terminología profesional y la terminología marcada por el proyecto.

② Para el mismo significado y nombre, los términos utilizados en las descripciones anteriores y posteriores deben ser consistentes.

③ Las fuentes utilizadas antes y después del documento deben ser consistentes.

④ El contenido de varios documentos sobre un mismo tema debe ser coherente y coherente sin contradicciones.

7. Legibilidad

① La descripción del texto debe ser fácil de entender.

② Utilice palabras apropiadas relacionadas con el contexto.

③ Utilice otros colores para distinguir los cambios del documento respecto a la versión anterior.

④ Los pasos de la prueba deben presentarse en forma de lista, marcados con números de serie numéricos como 1), 2), 3)...etc.