Escribir documentación

Escribir documentación en DeveloperHub no puede ser más fácil. En las páginas del editor, haz clic en cualquier parte del texto de tu documentación y empieza a escribir. Incluso puedes usar las herramientas de escritura con IA para ayudarte a crear el mejor contenido. Todo lo que hay en el editor se muestra tal como lo verán tus lectores, así que no hay vista dividida ni una vista previa separada que mantener sincronizada.

Formas de escribir

El editor es una de varias formas de incorporar contenido a tu documentación. Todas escriben en las mismas páginas, así que tu equipo puede elegir la que mejor le convenga y combinarlas libremente.

• En el editor. Escribe directamente en tu navegador, exactamente como lo verán tus lectores. De eso trata el resto de esta página.

• Como código, en Git. Sincroniza un repositorio de GitHub en ambos sentidos y escribe tus páginas como archivos, de modo que un cambio pueda pasar por una pull request antes de llegar a tus lectores.

• Desde un cliente de IA. Conecta Claude, Cursor u otro cliente MCP a tu proyecto y deja que encuentre, escriba y publique páginas por ti.

• Con el agente de IA. Describe lo que quieres en el panel de chat del editor y revisa las ediciones que sugiere antes de aplicarlas.

Edición

El editor funciona directamente sobre la página: lo que ves es lo que obtienen tus lectores. Hay tres cosas que conviene saber para moverte con rapidez.

• Añadir un bloque. Escribe / en una línea vacía para abrir el menú de inserción, y luego busca y elige el bloque que quieras (un destacado, una imagen, una tabla, un bloque de código y más). Consulta bloques para ver la lista completa.

• Dar formato al texto. Selecciona cualquier texto para abrir la barra de formato. Desde ahí puedes poner el texto en negrita, cursiva, subrayado, tachado o inline code, convertir el bloque en un encabezado o una lista con Convertir en, añadir un enlace o dejar un comentario.

• Mover o cambiar un bloque. Pasa el cursor sobre un bloque y usa el controlador de arrastre a su izquierda para moverlo, o abre el menú del controlador para ver más opciones, como eliminar el bloque.

También puedes insertar enlaces, variables y términos del glosario en línea escribiendo @, % o <.

Secciones de la página

Las páginas deben tener un título y un contenido.

Título

El título de la página será visible en:

1. El índice de la documentación.

2. El título de la pestaña del navegador.

3. La URL de la página.

Por eso, elige el título con cuidado para que sea significativo para tus lectores.

Contenido

El contenido de la página puede constar de texto, tablas, imágenes, enlaces, bloques de código, listas, cuadros de información y mucho más. Consulta bloques para ver todo el contenido que admitimos de forma nativa.

Guardar

Para guardar una página, pulsa el botón Guardar borrador en la esquina inferior derecha. Tus ediciones se guardarán en modo borrador hasta que las publiques. Cada edición que hagas se guarda en el historial de la página.

Cuando estés listo para publicar los cambios para tus lectores, haz clic en el botón Publicar .

Corrector ortográfico

El corrector ortográfico de tu navegador hace su trabajo de inmediato.