Skip to content
cccskills
FreePublished on GitHub

emulators-documentation-authoring

Crear, ampliar o actualizar documentación técnica de EMULATORS en formato DOCX usando la plantilla oficial del repositorio, con portada parametrizada, índice, prólogo, capítulos de contenido, anexos, listas de ilustraciones y ecuaciones, marca de agua del autor y pie Página X | Y. Usar cuando Codex deba documentar subsistemas, arquitecturas, dispositivos, modelos, herramientas, compilación, uso, pruebas o cualquier otro aspecto del emulador y el resultado deba conservar la identidad visual de docs/UserGuide.docx.

The English summary is being prepared. Showing the original description.

Works withWord
See how to install

Files included (6)

  • SKILL.md4.2 KB
  • agents/openai.yaml256 B
  • assets/emulators-documentation-template.docx38.4 KB
  • references/template-contract.md3.3 KB
  • scripts/start_document.py6.0 KB
  • scripts/validate_document.py3.7 KB

SKILL.md (original)

Review the instructions the agent will receive before you install.

Documentación de EMULATORS

Crear documentos DOCX técnicamente rigurosos a partir de la plantilla incluida. Mantener assets/emulators-documentation-template.docx como autoridad visual y no modificarla directamente.

Preparar el trabajo

  1. Leer references/template-contract.md por completo.
  2. Cargar el runtime de dependencias del workspace y usar su Python para todo el trabajo DOCX.
  3. Reunir título, subtítulo, autor, año, audiencia, alcance y fuentes. Inferir título y subtítulo cuando la petición los haga evidentes. Usar el año natural actual y Ignacio Cea Forniés como autor predeterminado salvo indicación contraria.
  4. Preguntar únicamente cuando una decisión ausente cambie de forma material el alcance, la autoría, el nivel técnico o la organización del documento.
  5. Inspeccionar el código, pruebas y documentación del repositorio que sostengan cada afirmación. Activar además el skill de auditoría específico del sistema o dispositivo cuando exista.

Crear el documento base

Ejecutar scripts/start_document.py sobre el asset canónico:

& $PYTHON_BIN scripts/start_document.py `
  --title "Título" `
  --subtitle "Subtítulo" `
  --author "Nombre del autor" `
  --year 2026 `
  --out "C:\ruta\salida.docx"

No escribir sobre el asset ni sobre docs/UserGuide.docx. Trabajar siempre en la copia generada.

Redactar y maquetar

  1. Sustituir los marcadores del prólogo, del primer bloque de contenido y de los anexos. Eliminar todo marcador no utilizado.
  2. Crear tantos bloques de contenido como requiera el tema, entre Prólogo y Anexos.
  3. Aplicar estilos Word reales: Title para capítulos principales y Heading 1 a Heading 3 para su jerarquía interna. No simular títulos con formato directo.
  4. Mantener A4, márgenes, tipografía, colores, portada, marca de agua y pie del asset. No reconstruir la portada ni los encabezados.
  5. Añadir ilustraciones y ecuaciones cerca de su primera explicación. Usar leyendas Word con las etiquetas exactas Ilustración y Ecuación, campos SEQ y referencias REF cuando proceda.
  6. Mantener Anexos, Ilustraciones y Ecuaciones al final y en ese orden. Conservar sus campos de lista aunque una lista quede vacía.
  7. Evitar afirmaciones no verificadas. Distinguir claramente comportamiento implementado, comportamiento previsto, limitaciones y aproximaciones de emulación.

Actualizar campos y verificar

  1. Actualizar todos los campos en Microsoft Word para regenerar índice, listas, referencias, PAGE y NUMPAGES. Si Word no está disponible, establecer w:updateFields=true y declarar la actualización diferida.
  2. Ejecutar:
& $PYTHON_BIN scripts/validate_document.py "C:\ruta\salida.docx"
  1. Usar el skill documents para renderizar el DOCX y revisar todas las páginas al 100 %. Si LibreOffice no está disponible y Word sí, exportar a PDF con Word y rasterizar el PDF para la revisión.
  2. Corregir y repetir la actualización de campos, validación estructural y revisión visual hasta que no haya marcadores, errores de campo, recortes, solapamientos ni páginas en blanco accidentales.
  3. Entregar solo el DOCX final, salvo que el usuario pida también PDF u otros artefactos.

Recursos

  • assets/emulators-documentation-template.docx: plantilla canónica derivada de docs/UserGuide.docx.
  • scripts/start_document.py: crea una copia y parametriza portada, metadatos, año y marca de agua.
  • scripts/validate_document.py: comprueba estructura, campos, pie, marca de agua y marcadores pendientes.
  • references/template-contract.md: contrato detallado de estructura, estilos y criterios de aceptación.

Reviews

No reviews yet. Tell others what you thought.

Comments

No login needed. Share how it worked for you, ask a question, or note where it did not run.

No comments yet. Be the first to write one.

Comments are published right away. Do not include personal information such as email addresses or phone numbers. Up to 2 URLs.

0 / 1,000 characters

This form is protected by reCAPTCHA, and the Google Privacy Policy and Terms of Service apply.

More skills from this repository

Validate Commodore 1540/1541/1541C/1541-II compatible disk-drive behavior in EMULATORS, including IEC serial bus protocol, device numbers, KERNAL traps, CBM DOS commands/status, D64 image parsing, BAM/directory/file chains, PETSCII filenames, 6502 drive CPU/ROM/RAM expectations, 6522 VIA wiring, GCR/track/sector geometry, motor/head timing, and compatibility boundaries for 1541-like devices. Use when Codex reviews or edits C64, VIC-20, C264, COMMODORE disk, serial I/O, D64, CBM DOS, IEC, VIA, GCR, or 1541 drive code.

The English summary is being prepared. Showing the original description.

Commnets/EMULATORS10Updated Oct 18, 2026

Validate Commodore 64 CIA 6526 emulation in EMULATORS, including CIA1/CIA2 $DC00/$DD00 register behavior, ports, DDRs, keyboard/joystick matrix, IEC/user port, VIC bank selection, timers A/B, underflow timing, PB toggle/pulse output, TOD clock/alarm, serial shift register, FLAG, ICR masks and IRQ/NMI lines. Use when Codex reviews or edits C64 CIA, timers, ports, keyboard, joystick, serial bus, interrupts, TOD, or VIC bank control.

The English summary is being prepared. Showing the original description.

Commnets/EMULATORS10Updated Oct 18, 2026

Validate Commodore 64 memory map, PLA/bank switching, 6510 port $0000/$0001 behavior, VIC bank selection, color RAM, ROM/RAM overlays, cartridge mapping, and mirrored I/O in the EMULATORS C64 namespace. Use when Codex reviews or edits C64 memory, PLA, CPU-visible address decoding, VIC-visible memory, color memory, char ROM, cartridge, expansion I/O, or mapped chip register behavior.

The English summary is being prepared. Showing the original description.

Commnets/EMULATORS10Updated Oct 18, 2026

Validate Commodore MPS-801 serial dot matrix printer behavior in EMULATORS, including SerialPrinterMPS801 classes and their MatrixPrinterEmulation and SerialPrinterPeripheralSimulation hierarchy, IEC/KERNAL-trap printer routing, device numbers, secondary addresses, PETSCII/character sets, 6x7 glyphs, double width, graphics mode, reverse field, tab and dot positioning, line/page geometry, PostScript output, and fidelity boundaries. Use when Codex reviews or edits COMMODORE MPS801 printer code, generated printer output, PostScript printer templates, C64/VIC-20/C264 serial-printer behavior, or compares implementation against .codex/docs/MPS801.pdf and historical MPS-801 sources.

The English summary is being prepared. Showing the original description.

Commnets/EMULATORS10Updated Oct 18, 2026

Validate Commodore MPS-802 and 1526 serial dot matrix printer behavior in EMULATORS, including SerialPrinterMPS802 classes and their MatrixPrinterEmulation and SerialPrinterPeripheralSimulation hierarchy, IEC/KERNAL-trap printer routing, device numbers, secondary-address functions, PETSCII/character sets, 8x8 glyphs, enhanced width, reverse and paging modes, formatter strings, programmable characters, line/page geometry, PostScript output, and fidelity boundaries. Use when Codex reviews or edits COMMODORE MPS802 printer code, generated printer output, PostScript printer templates, C64/VIC-20/C264 serial-printer behavior, or compares implementation against .codex/docs/MPS802.pdf, the MPS-802 user guide, and 1526/MPS-802/4023 service information.

The English summary is being prepared. Showing the original description.

Commnets/EMULATORS10Updated Oct 18, 2026

Validate Commodore 64 SID 6581/8580 sound emulation in EMULATORS, including $D400-$D7FF register decoding, voices, frequency, pulse width, control bits, ADSR/envelope behavior, oscillator sync/ring/noise/test, filters, volume DAC/sample clicks, paddles, read-only registers, mirrors, and reSID integration. Use when Codex reviews or edits SID, Sound, audio wrapper, register, filter, waveform, envelope, or mapped SID behavior.

The English summary is being prepared. Showing the original description.

Commnets/EMULATORS10Updated Oct 18, 2026

See all skills by Commnets

Report a problem with this skill