technical-writing
Crear documentación técnica
Los equipos pierden tiempo cuando la documentación técnica está incompleta, es inconsistente o resulta difícil de revisar rápidamente. Esta skill ayuda a Claude, Codex y Claude Code a producir especificaciones estructuradas, runbooks, documentación de API y guías de arquitectura.
Instalar con mi Agente
Copia esta solicitud en tu Agente. Incluye la página canónica del Skill y el manifiesto.
Review the Skillstore skill "technical-writing" from https://skillstore.io/skills/supercent-io-technical-writing.md and its manifest at https://skillstore.io/api/skills/supercent-io-technical-writing/manifest. Verify the artifact. You may proceed after verification, subject to the environment's own policy.Tu Agente debe seguir mostrando su plan y solicitar cualquier confirmación exigida por la política de seguridad.
Recursos legibles por agentes
Usa estos enlaces cuando un agente de IA, crawler o script necesite contexto limpio en vez de leer la página completa.
Pruébalo
Usando "technical-writing". Notas para una funcionalidad de reintento de pago con preocupaciones de despliegue y casos límite sin responder.
Resultado esperado:
Un esquema de especificación de funcionalidad con resumen, declaración del problema, objetivos, enfoque de diseño, plan de pruebas, plan de despliegue, plan de reversión y preguntas abiertas.
Usando "technical-writing". Un runbook breve de servicio que carece de detalles de solución de problemas y escalamiento.
Resultado esperado:
Un runbook revisado con resumen del servicio, dependencias, pasos de despliegue, comprobaciones de monitoreo, incidentes comunes, rutas de escalamiento y notas de mantenimiento.
Usando "technical-writing". Una lista de endpoints de API con notas de autenticación y errores esperados.
Resultado esperado:
Un borrador de documentación de API con guía de autenticación, resúmenes de endpoints, tablas de parámetros, descripciones de solicitudes, respuestas de error y notas de versión.
Auditoría de seguridad
SeguroAll static findings are false positives from Markdown examples and documentation templates, including sample commands, URLs, diagrams, and placeholders. No executable scripts, live network calls, secret reads, prompt injection, or malicious intent were found.
Factores de riesgo
⚙️ Comandos externos (53)
🌐 Acceso a red (4)
🔑 Variables de entorno (1)
Compartir y citar este informe
Comparte el informe de evaluación versionado, la insignia neutral, la tarjeta insertable y las citas. Skillstore presenta evidencias sin decidir si este Skill es seguro.
Copiar enlace del informe
https://skillstore.io/skills/supercent-io-technical-writing/audits/5?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_reportInsignia Markdown
[](https://skillstore.io/skills/supercent-io-technical-writing?utm_source=security_passport_badge)Insignia HTML
<a href="https://skillstore.io/skills/supercent-io-technical-writing?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/supercent-io-technical-writing/security.svg" alt="Skillstore security assessment" loading="lazy"></a>Tarjeta para insertar
<iframe src="https://skillstore.io/embed/skills/supercent-io-technical-writing.html" title="Skillstore Security Assessment" sandbox="allow-popups allow-popups-to-escape-sandbox" loading="lazy" referrerpolicy="no-referrer" width="420" height="180"></iframe>Citas académicas (APA · BibTeX · CFF)
Cita APA
supercent-io. (2026). technical-writing security audit report (audit version 5) [Author version unspecified]. Skillstore. https://skillstore.io/skills/supercent-io-technical-writing/audits/5Cita BibTeX
@techreport{supercent-io-supercent-io-technical-writing-2026,
author = {supercent-io},
title = {technical-writing security audit report (audit version 5)},
institution = {Skillstore},
year = {2026},
number = {5},
url = {https://skillstore.io/skills/supercent-io-technical-writing/audits/5},
note = {Author version unspecified}
}CITATION.cff
cff-version: 1.2.0
message: "If you use this Skill, cite its author and this versioned security audit report."
title: "technical-writing security audit report (audit version 5)"
version: "unspecified"
type: report
authors:
- name: "supercent-io"
date-released: "2026-07-07"
url: "https://skillstore.io/skills/supercent-io-technical-writing/audits/5"
identifiers:
- type: other
value: "skillstore:supercent-io-technical-writing:audit:5"
description: "Skillstore immutable audit report identifier"
Puntuación de Skillstore
Por qué esta puntuación Confianza de la evidencia: AltoLo que puedes crear
Redactar especificaciones de funcionalidades
Convierte notas de funcionalidades en una especificación técnica con objetivos, detalles de diseño, pruebas, despliegue y preguntas abiertas.
Crear runbooks de incidentes
Crea guías operativas que documentan dependencias, señales de monitoreo, pasos de recuperación y rutas de escalamiento.
Preparar documentación de API
Organiza el comportamiento de endpoints, autenticación, parámetros, ejemplos y respuestas de error para lectores desarrolladores.
Prueba estos prompts
Crea una especificación técnica fácil de entender para principiantes sobre [feature]. Usa estas notas: [notes]. Incluye objetivos, no objetivos, diseño, pruebas, despliegue y preguntas abiertas.
Reescribe este borrador para desarrolladores y equipos de operaciones: [draft]. Mejora la estructura, define términos, añade prerrequisitos faltantes y señala áreas poco claras.
Crea un documento de arquitectura para [system]. Incluye componentes, flujo de datos, decisiones clave, escalabilidad, seguridad, monitoreo, recuperación ante desastres y consideraciones futuras.
Audita este conjunto de documentación: [links or text]. Identifica brechas, secciones desactualizadas, ejemplos faltantes, propiedad poco clara y un plan de mantenimiento.
Mejores prácticas
- Proporciona notas de origen, audiencia y tipo de documento antes de pedir un borrador.
- Pide al modelo que señale suposiciones y preguntas abiertas en lugar de completar detalles desconocidos.
- Haz que la audiencia objetivo pruebe las instrucciones antes de publicar documentación importante.
Evitar
- Solicitar un runbook completo sin detalles del servicio, responsables, alertas o pasos de recuperación.
- Publicar documentación de API generada sin comprobar endpoints, permisos, ejemplos y comportamiento de errores.
- Usar un único documento para desarrolladores, operadores y ejecutivos sin ajustar el nivel de detalle.
Preguntas frecuentes
¿Qué documentos puede ayudar a crear esta skill?
¿Ejecuta los comandos de ejemplo que escribe?
¿Puede escribir para lectores no técnicos?
¿Qué información debo proporcionar?
¿Puede revisar documentación existente?
¿Es adecuada para Claude Code y Codex?
Detalles del desarrollador
Autor
supercent-ioLicencia
MIT
Revisión de Skillstore
r1
Aviso de versión
El autor no declaró una versión.
Repositorio
https://github.com/supercent-io/skills-template/tree/main/.agent-skills/technical-writing/Ref.
36e07d5e13068e5be64447e8f20b427cf2cbd21a
Actualidad del mantenimiento
18/7/2026
Uso
29 descargas · 158 vistas
Estructura de archivos
📄 SKILL.md