Guía de Estilo de Documentación para NorTK
Contenido de la guía:
1. Principios editoriales y filosofía
1.1. Propósito y audiencia objetivo
1.2. Didáctica basada en hechos
1.3. Gestión de la carga cognitiva
1.4. Fundamentación empírica de juicios de valor
1.5. Voz activa y persona gramatical
1.6. Normas ortográficas de capitalización en títulos
1.7. Erradicación del antropomorfismo
1.8. Identificación proactiva de trampas operativas
1.9. Accesibilidad estructural y coherencia auditiva
2. Arquitectura modular de documentos
2.1. Fundamentos del modelo basado en temas
2.2. Taxonomía de unidades documentales
2.2.1. Módulos de concepto
2.2.2. Módulos de procedimiento
2.2.3. Módulos de referencia
2.2.4. Ensamblajes
2.3. Independencia de contexto y reutilización
2.4. Convenciones de nomenclatura y títulos
3. Procedimientos operativos y verificación
3.1. El contrato de cinco bloques
3.2. Bloque 1: propósito y contexto operativo
3.3. Bloque 2: prerrequisitos
3.4. Bloque 3: procedimiento paso a paso
3.5. Bloque 4: verificación determinista
3.6. Bloque 5: recursos adicionales
3.7. Manejo de privilegios y prompts de terminal
3.8. Plantilla canónica de procedimiento
4. Convenciones de interfaz y tipografía
4.1. Notación formal de sintaxis de comandos
4.2. Elementos tipográficos de la línea de comandos
4.3. Interfaces en modo texto y gráficas
4.4. Nomenclatura y acciones de teclado
4.5. Unidades de medida y prefijos binarios frente a decimales
4.6. Formatos de fecha, hora y redes
4.7. Reglas para capturas de pantalla y recursos gráficos
5. Mensajería del sistema y gestión de errores
5.1. La anatomía canónica de cuatro partes
5.2. Componente 1: identificador de mensaje
5.3. Componente 2: texto del mensaje
5.4. Componente 3: explicación técnica
5.5. Componente 4: respuesta del operador
5.6. Tipos y niveles de severidad de mensajes
5.7. Uso disciplinado de admoniciones en Sphinx
5.8. Catálogo de trampas comunes
6. Estándar de marcado reStructuredText
6.1. Jerarquía canónica de encabezados
6.2. Indentación a tres espacios
6.3. Reglas para listas y sublistas anidadas
6.4. Bloques de código y lenguajes soportados
6.5. Directiva cardinal para diagonales
6.6. Validación automática con rstcheck
7. Glosario y terminología técnica
7.1. Criterios de traducción al español técnico
7.2. Términos canónicos que no se traducen
7.3. Catálogo de traducciones obligatorias
7.4. Pronunciación y verbalización de código
Control de versiones:
Bitácora
[Sin publicar]
[0.1.0] - 2026-09-21
Cómo contribuir
Principios editoriales indispensables
Requerimientos del entorno en Fedora Linux
Flujo de desarrollo y verificación
Protocolo de control de cambios y confirmaciones
Mandato de registro en Bitácora y mantenimiento documental
Licencia de las contribuciones
Guía de Estilo de Documentación para NorTK
Índice
Índice