Claude Code
Configura Claude Code para escribir y mantener la documentación de Jamdesk. Incluye plantilla de CLAUDE.md y conexión al servidor MCP.
Claude Code es el CLI de Anthropic para Claude. Como lee el directorio completo de tu proyecto, detecta tu estilo de escritura existente y la estructura de tu docs.json a partir de los propios archivos, y luego escribe páginas que encajan con lo que ya tienes.
Nosotros mantenemos la propia documentación de Jamdesk con exactamente esta misma configuración. La plantilla de CLAUDE.md que aparece a continuación es muy similar a la que usamos nosotros. Personalízala para tu proyecto, pero te recomendamos conservar las reglas de estructura de página, la convención de tarjetas "¿Qué sigue?" y la lista estricta de componentes.
En comparación con Codex, el punto fuerte de Claude Code es la iteración interactiva. Puedes redactar una página, leer el resultado, pedirle cambios en una sección y hacer que la reescriba en la misma sesión, manteniendo siempre el contexto completo del proyecto. Codex es la mejor opción para tareas por lotes de varios archivos sin intervención; esta página trata el flujo de trabajo para todo lo demás.
Configuración rápida
Instala desde claude.ai/code.
Añade tu documentación como fuente de datos MCP:
claude mcp add --transport http my-docs https://your-project.jamdesk.app/_mcpSustituye your-project por tu subdominio de Jamdesk — o, si ya tienes un dominio personalizado activo, úsalo en su lugar: https://docs.acme.com/_mcp. Claude ya puede buscar y leer tu documentación publicada directamente. Consulta Servidor MCP para más detalles.
Crea un archivo CLAUDE.md en la raíz de tu proyecto de documentación. Esto le da a Claude un contexto coherente sobre tus estándares de documentación, los componentes disponibles y tu estilo de escritura.
Plantilla de CLAUDE.md
Añade este archivo a la raíz de tu proyecto de documentación de Jamdesk:
# Documentation Project
Jamdesk docs project. Pages are MDX (Markdown + React components). Config is in `docs.json`.
## How This Project Works
- `docs.json`: navigation structure, theme, colors, branding. Pages must be listed here to appear in the sidebar.
- `*.mdx` files: documentation pages. Every page needs `title` and `description` frontmatter.
- `images/`: static assets. Always use `.webp` format.
- `snippets/`: reusable MDX fragments. Import with `<Snippet file="name.mdx" />`.
## Page Template
Every page follows this structure:
---
title: Clear, Specific Title
description: One sentence. Used in search results and social previews.
---
Opening paragraph: what this page covers and who it's for. No heading needed.
## First Section
Content. Use components where they help, not for decoration.
## What's Next?
<Columns cols={2}>
<Card title="Related Page" icon="arrow-right" href="/path">
Why the reader would go here next
</Card>
</Columns>
The opening paragraph comes right after frontmatter, with no heading before it. "What's Next?" is always the last section. Card descriptions explain why, not what ("Set up search for your docs", not "Search configuration page").
## Writing Style
Start with why. What problem does this page solve? Show that first, then walk through how to use the feature.
Use progressive disclosure: a simple example near the top, advanced options tucked into Accordions or later sections.
Active voice. "Run this command", not "This command should be run".
One idea per paragraph. If you reach for "also" or "additionally", start a new paragraph instead.
Code examples must actually work. Never show partial code or pseudocode. Every block should be complete and copy-pasteable.
Write like a person. Skip filler like "It's important to note that", "This allows you to", or "seamlessly". Drop the hedging ("you might want to consider"). Read your output back, and if it sounds like a chatbot wrote it, rewrite it shorter and more direct.
## Components
Layout: Card, Columns, Tabs, Tab, Accordion, AccordionGroup, Steps, Step, Expandable, Frame, CodeGroup
Callouts: Note, Info, Warning, Tip, Check, Danger
When to use each:
| Component | Use for | Don't use for |
|-----------|---------|---------------|
| Tabs | Mutually exclusive choices (npm/yarn, languages) | Sequential content |
| Steps | Ordered procedures | Unordered lists of features |
| Accordion | Optional/advanced detail | Core content readers need |
| Card (in Columns) | Navigation links, feature grids | Inline content |
| Note/Tip/Warning | Important context the reader might miss | Every other paragraph |
Cards always go inside Columns:
<Columns cols={2}>
<Card title="Page Title" icon="icon-name" href="/path">
Brief description
</Card>
</Columns>
Icons are Font Awesome Light names: "rocket", "code", "terminal", "book-open", "gear"
## Adding Pages
1. Create the `.mdx` file
2. Add the page path (no `.mdx` extension) to `docs.json` in the right navigation group
3. Link to it from related pages via "What's Next?" cards
**If you skip step 2, the page won't show up in the sidebar.** Read `docs.json` before creating pages so you understand the navigation structure.
## Before You're Done
Check your work:
- [ ] Frontmatter has both `title` and `description`
- [ ] Opening paragraph exists (no heading before it)
- [ ] Page ends with "What's Next?" cards
- [ ] New pages are added to `docs.json` navigation
- [ ] Code examples are complete and copy-pasteable
- [ ] No invented components; only the ones listed above
- [ ] No raw HTML tags; use MDX components
- [ ] Images use `.webp` format
## Common Mistakes
- Inventing components like `<CodeBlock>`, `<Alert>`, or `<Section>`. They don't exist. Use the components listed above.
- Wrapping code in components. Code blocks are standard Markdown triple backticks. Don't wrap them in `<CodeGroup>` unless you're showing multiple language alternatives.
- Skipping description frontmatter. Every page needs it; it appears in search results and link previews.
- Using `<Card>` without `<Columns>`. Cards must be inside a `<Columns>` wrapper.
- Writing "click here" links. Use descriptive link text: [Migration guide](/setup/migration), not [click here](/setup/migration).Personaliza la plantilla para tu proyecto. Añade el nombre de tu producto, las convenciones de tu API, la terminología y cualquier guía de contenido propia de tu documentación.
Prompts de ejemplo
Una vez que tu CLAUDE.md y la conexión MCP estén configurados, no necesitas explicarlo todo con detalle. Claude ya tiene el contexto del proyecto, así que los prompts cortos funcionan mejor que los largos.
Un punto de partida habitual: "Escribe una guía de introducción para [función]". Como Claude ya ha leído tus otras páginas, capta tu tono sin que se lo indiques. Para detectar desviaciones, pídele que revise una página comparándola con el resto del sitio. Claude suele detectar las pequeñas inconsistencias (un componente usado de forma distinta aquí que allá, un cambio de tono entre secciones) que a los autores se les pasan por alto en su propia revisión.
Los prompts que más sorprenden a la gente son los de limpieza. "Convierte este README en páginas de documentación" transforma un solo archivo en un conjunto correctamente estructurado con navegación. Si le indicas una página existente y le pides una sección de preguntas frecuentes basada en Accordion, extrae problemas reales de tu repositorio, mucho más cercanos a las preguntas reales de los lectores que cualquier cosa que escribirías partiendo de una página en blanco.
La skill /update-jamdesk
Para automatizar las actualizaciones de la documentación cuando cambie el código, instala la skill /update-jamdesk:
npx skills add jamdesk/skills --skill update-jamdeskDespués de implementar una función visible para el usuario, ejecuta /update-jamdesk y Claude determinará qué páginas de documentación hay que crear o editar. Consulta Actualizaciones automatizadas para la guía completa.