Saltar al contenido principal

Guía de Estilo del Manual del Espectro Satelital

Esta guía de estilo establece las reglas para escribir, dar formato, referenciar y traducir el contenido del Manual del Espectro Satelital. Estas reglas son impuestas por nuestros agentes automatizados y son obligatorias para todos los colaboradores.

1. Tono y Estilo del Lenguaje​

  • Fácil de entender: Escriba en un inglés claro y sencillo (o en el idioma de destino respectivo). Evite la jerga administrativa o legal demasiado densa. Cuando se deban utilizar términos técnicos (por ejemplo, NGSO, epfd, puesta en servicio), explíquelos inmediatamente mediante analogías.
  • Fáctico y Objetivo: Todo el material debe ser estrictamente objetivo, fáctico y educativo.
  • Sin Sesgo Comercial: Absolutamente nada de marketing, promoción de productos, autopromoción o redacción sesgada. No recomiende ni elogie a operadores comerciales, lanzadores o fabricantes de hardware específicos, a menos que sean necesarios como contexto fáctico (por ejemplo, mencionar Starlink de SpaceX o OneWeb puramente como ejemplos de megaconstelaciones no geoestacionarias).
  • Inclusivo y Neutro: Evite los sesgos regionales. No asuma que al lector solo le interesan las regulaciones de la FCC de EE. UU.; equilibre con la UIT-R, Ofcom (Reino Unido), ISED (Canadá) y otras administraciones globales.

2. Formato y Markdown (MDX)​

  • Advertencias: Utilice las advertencias nativas de Docusaurus para resaltar reglas o consejos importantes. Los títulos personalizados son compatibles utilizando corchetes en la línea de apertura, que también acepta el formato estándar de Markdown: 
    :::note[Su título **con** algo de _sintaxis_ `Markdown`!]

    Este es un hito regulatorio crítico.

    :::
  • Diagramas: Utilice bloques de Mermaid para explicar configuraciones orbitales complejas o flujos de trabajo de presentación de solicitudes. Siempre envuelva los bloques de Mermaid en contenedores <div className="text--center"> con espaciado de línea en blanco para garantizar la compatibilidad con HTML/MDX: 
    <div className="text--center">

    ```mermaid
    graph TD
        A[Publicación Anticipada] --> B[Solicitud de Coordinación]
        B --> C[Notificación y BIU]
    ```

    </div>
    • Formato de Mermaid y Paleta de Colores:
      • Centrado: Los diagramas de Mermaid siempre deben estar centrados horizontalmente en la página utilizando el formato de contenedor del ejemplo. Asegúrese de mantener un espacio adecuado (líneas vacías) alrededor de las etiquetas div y del bloque de código para que el analizador de Markdown/MDX funcione correctamente.
      • Sin Desplazamiento Horizontal: Mantenga los diagramas simples y verticales para que se adapten de forma limpia a las vistas móvil y de escritorio. Divida los diagramas complejos o densos en múltiples diagramas más pequeños colocados secuencialmente.
      • Tema Consolidado: Todos los elementos de Mermaid tienen un estilo global a través de src/css/custom.css. No utilice estilos en línea ni colores personalizados aleatorios en los códigos de los diagramas individuales, excepto para los bordes de diseño cleanNode de subgrafos.
      • Plantilla de Subgrafo: Para subgrafos en diagramas de Mermaid, defina y aplique siempre la plantilla cleanNode para mantener los fondos transparentes y usar un borde azul oscuro limpio:
      • Paleta Visual: Los subgrafos utilizan (classDef cleanNode fill:none,stroke:#102a43,stroke-width:1px;) con un borde Slate limpio (#cbd5e1/#475569), reemplazando los fondos amarillos/dorados brillantes predeterminados. Los nodos utilizan un relleno blanco/slate oscuro con bordes Slate y esquinas redondeadas.
      • Espaciadores de diseño (Spacers): Utilice enlaces invisibles ~~~ para separar subgrafos o nodos para mejorar la legibilidad en diseños complejos. Los espaciadores pueden ser horizontales (en graph LR) o verticales (en graph TD):
  • Ecuaciones: Las ecuaciones LaTeX deben estar centradas y en una nueva línea a menos que encajen bien en línea, utilizando un contenedor de centrado. Dado que los caracteres $ inician la representación de LaTeX, cualquier carácter $ crudo que no sea una ecuación (como las referencias monetarias de $1 millón) debe escaparse como \$ para evitar problemas de análisis: 
    <div className="text--center">
    $$P_{\text{dBW}} = 10 \log_{10}(P_{\text{Watts}})$$
    </div>

3. Requisitos de SEO​

Cada capítulo debe estar altamente optimizado para motores de búsqueda con el fin de garantizar la visibilidad tanto para profesionales reguladores como para principiantes:

  • Título: Menos de 60 caracteres, rico en palabras clave y único.
  • Descripción: Menos de 160 caracteres. Debe resumir el capítulo con precisión e incluir de forma natural palabras clave objetivo (por ejemplo, "licencias de espectro satelital", "proceso de coordinación de la UIT").
  • Jerarquía de Encabezados:
    • El título de la página en el frontmatter genera el único <h1> de la página.
    • No utilice # en el cuerpo. Comience los encabezados del cuerpo con ## (H2) y las secciones anidadas con ### (H3).
  • Enlaces Internos: Vincule páginas utilizando texto de anclaje descriptivo (por ejemplo, Lea sobre los [derechos de aterrizaje](./landing-rights.md)). Nunca utilice frases genéricas como "haga clic aquí" o "saber más".

4. Referencias y Enlaces Externos​

Todas las declaraciones regulatorias deben estar referenciadas para mantener la credibilidad profesional:

  • Formato: Indique la administración u organismo, seguido de la regulación específica o el nombre del documento de recomendaciones.
  • Ejemplos:
    • Reglamento de Radiocomunicaciones de la UIT, Artículo 9 (Edición de 2020)
    • Título 47 del CFR de la FCC, Parte 25
    • Estrategia de Espectro Espacial de Ofcom (2022)
  • Enlaces: Proporcione enlaces directos a sitios públicos oficiales (por ejemplo, ITU.int, FCC.gov, Ofcom.org.uk) donde los lectores puedan descargar o leer los documentos de origen. Asegúrese de que los enlaces sean permanentes y seguros (HTTPS).

5. Navegación al Final de los Capítulos y Contenido Relacionado​

Cada página del manual debe terminar con una sección de navegación estándar para guiar al lector:

---

## Próximos Pasos
* **Próximo Tema**: [Nombre del Próximo Capítulo](./next-chapter-file.md) - Breve frase que describa lo que cubre el próximo capítulo.
* **Conceptos Relacionados**:
  - [Concepto A](./another-file.md) - Explicación rápida de cómo se relaciona.
  - [Concepto B](./yet-another-file.md) - Explicación rápida.
* **Lecturas Adicionales**:
  - [Guía de presentación de la UIT](https://www.itu.int/...) - PDF de referencia o portal.