Directrices para Contribuir a la Documentación de NorTK

Entidad:

NorTK: Infraestructura Crítica y Soberanía Digital con Software Libre

Sitio Web:

https://nortk.com/

Licencia:

GNU Free Documentation License, Versión 1.3 o posterior

Este documento establece las normas operativas, estándares de calidad y flujos técnicos obligatorios para colaborar en la redacción, mantenimiento y evolución de la documentación técnica de NorTK.

Principios editoriales indispensables

Toda contribución debe satisfacer de manera estricta los preceptos fundacionales del proyecto:

  • Realismo técnico y rigor empírico: Todo procedimiento debe ser reproducible en un entorno limpio y contrastarse mediante comandos de verificación obligatorios con salidas de terminal reales.

  • Voz activa y modo imperativo directo: Redacte los pasos procedimentales como órdenes directas: Configure la interfaz, Inicie el daemon, Instale el paquete. Queda erradicada la voz pasiva.

  • Erradicación del antropomorfismo: No atribuya intenciones, emociones o pensamientos al software ni al hardware.

  • Español técnico sin anglicismos superfluos: Emplee la traducción canónica consolidada en español cuando exista y preserve términos técnicos estándar de la industria únicamente cuando constituyan estándar de facto en sistemas operativos POSIX/Linux.

  • Títulos limpios: Prohibido utilizar paréntesis en títulos o subtítulos. En español, los encabezados llevan mayúscula únicamente en la letra inicial y en los nombres propios. Queda prohibida la mayúscula sostenida.

  • Directiva cardinal de diagonales: Jamás coloque espacios alrededor de barras diagonales. Escriba siempre palabra/palabra, nunca palabra / palabra.

Requerimientos del entorno en Fedora Linux

Para garantizar un entorno determinista, instale los paquetes requeridos mediante DNF:

# dnf install -y make python3-sphinx python3-sphinx_rtd_theme python3-sphinx-autobuild python3-rstcheck latexmk texlive-latex texlive-collection-fontsrecommended

Flujo de desarrollo y verificación

  1. Configure los hooks de Git en su copia local:

    $ make hooks
    
  2. Inicie el servidor de desarrollo interactivo con recarga en vivo:

    $ make dev
    
  3. Valide y corrija automáticamente omisiones comunes de formato en fuentes RST:

    $ make fix
    
  4. Ejecute la auditoría estática de sintaxis antes de preparar sus confirmaciones:

    $ make lint
    
  5. Genere el documento PDF completo mediante Sphinx para validar la maquetación imprimible:

    $ make latexpdf
    

Protocolo de control de cambios y confirmaciones

  • Formato de confirmación: Utilice el estándar Conventional Commits:

    tipo(alcance): descripción breve en imperativo
    
  • Tráilers obligatorios: Toda confirmación debe incluir firma formal y registro de coautoría:

    Co-authored-by: Antigravity <antigravity@google.com>
    Signed-off-by: Nombre Apellido <correo@dominio.com>
    

Mandato de registro en Bitácora y mantenimiento documental

Toda modificación realizada en el repositorio debe cumplir obligatoriamente con las siguientes directivas de sincronización:

  1. Registro obligatorio en la Bitácora (CHANGELOG.rst): Ninguna adición, corrección, rediseño o ajuste estructural se considera concluido sin su correspondiente registro en el archivo CHANGELOG.rst bajo las secciones canónicas Agregado, Modificado, Deprecado, Eliminado, Corregido o Seguridad.

  2. Evaluación y actualización de README.rst y CONTRIBUTING.rst: Ante cualquier cambio que altere dependencias, herramientas, flujos de trabajo, objetivos de compilación o políticas de desarrollo, el colaborador debe evaluar de forma obligatoria el estado de README.rst y CONTRIBUTING.rst y aplicar las actualizaciones necesarias en el mismo conjunto de cambios.

Licencia de las contribuciones

Al colaborar en este proyecto, usted acepta de forma vinculante que toda su documentación, código, hojas de estilo y artefactos complementarios se publiquen bajo los términos de la Licencia de Documentación Libre de GNU (GNU Free Documentation License), Versión 1.3 o cualquier versión posterior aprobada por la Free Software Foundation.