Documentación técnica clara y consistente.
La documentación parte de la tarea del lector, usa términos estables y permite verificar cada procedimiento.
Jerarquía editorial
| Prioridad | Fuente |
|---|---|
| 1 | Norma específica del proyecto |
| 2 | Norma de prosa del workspace y esta guía |
| 3 | Google Developer Documentation Style Guide para vacíos técnicos |
| 4 | Referencia lingüística o técnica especializada |
Página de referencia
- Título que anticipa el tema.
- Primera oración con propósito y audiencia cuando hace falta.
- Términos consistentes y definidos en su primer uso.
- Enlaces con destino reconocible fuera de contexto.
- Ejemplos mínimos que usan la versión documentada.
- Fecha solo cuando informa vigencia o frescura.
Procedimientos
- Declarar requisitos previos.
- Iniciar cada paso con una acción.
- Separar pasos opcionales y condiciones.
- Explicar el resultado observable después del comando.
- Usar el nombre exacto de los elementos de interfaz.
- Cerrar con verificación, siguiente paso o rollback.
Contenido durable
- Describir el estado presente del producto.
- Evitar promesas de funciones futuras dentro de una referencia vigente.
- Usar lenguaje literal para una audiencia global.
- Mantener anclas de títulos estables.
- Registrar cambios sustantivos en una página de novedades.
Referencia Google
Decisiones
Usa el identificador para confirmar, modificar o rechazar una regla.
TECHDOC-01Pendiente de aprobaciónLa norma específica del proyecto prevalece sobre referencias externas.
TECHDOC-02Pendiente de aprobaciónCada procedimiento declara requisitos, acciones y resultado verificable.