documentation-writer
Crear documentación de software con Diataxis
Los equipos a menudo necesitan documentación que coincida con la intención del usuario en tutoriales, guías prácticas, páginas de referencia y explicaciones. Esta skill guía a Claude, Codex y Claude Code para aclarar el alcance, proponer un esquema y redactar Markdown estructurado.
Esta habilidad forma parte de un paquete
Instala el paquete completo y obtén en un solo comando todas las habilidades que necesita la tarea.
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 "documentation-writer" from https://skillstore.io/skills/github-documentation-writer.md and its manifest at https://skillstore.io/api/skills/github-documentation-writer/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 "documentation-writer". Una solicitud para escribir documentación de incorporación para una nueva funcionalidad de desarrollador.
Resultado esperado:
Preguntas aclaratorias sobre la audiencia y el objetivo, seguidas de un esquema de tutorial centrado en un primer resultado exitoso.
Usando "documentation-writer". Un esquema aprobado para una tarea de despliegue.
Resultado esperado:
Una guía práctica en Markdown con requisitos previos, pasos ordenados, resultados esperados y notas concisas de resolución de problemas.
Usando "documentation-writer". Archivos Markdown existentes que definen el tono y la terminología del producto.
Resultado esperado:
Un borrador de documentación revisado que sigue la misma voz, nomenclatura y estructura sin copiar el texto fuente.
Auditoría de seguridad
SeguroThe skill contains prompt guidance for technical writing and no executable network operation. The Diátaxis website URL is a framework citation, not a request target or data transfer mechanism.
Factores de riesgo
🌐 Acceso a red (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/github-documentation-writer/audits/5?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_reportInsignia Markdown
[](https://skillstore.io/skills/github-documentation-writer?utm_source=security_passport_badge)Insignia HTML
<a href="https://skillstore.io/skills/github-documentation-writer?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/github-documentation-writer/security.svg" alt="Skillstore security assessment" loading="lazy"></a>Tarjeta para insertar
<iframe src="https://skillstore.io/embed/skills/github-documentation-writer.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
github. (2026). documentation-writer security audit report (audit version 5) [Author version unspecified]. Skillstore. https://skillstore.io/skills/github-documentation-writer/audits/5Cita BibTeX
@techreport{github-github-documentation-writer-2026,
author = {github},
title = {documentation-writer security audit report (audit version 5)},
institution = {Skillstore},
year = {2026},
number = {5},
url = {https://skillstore.io/skills/github-documentation-writer/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: "documentation-writer security audit report (audit version 5)"
version: "unspecified"
type: report
authors:
- name: "github"
date-released: "2026-07-23"
url: "https://skillstore.io/skills/github-documentation-writer/audits/5"
identifiers:
- type: other
value: "skillstore:github-documentation-writer:audit:5"
description: "Skillstore immutable audit report identifier"
Comparar variantes
2 variantes instalablesCada autor sigue siendo un skill instalable independiente. La variante recomendada se ordena según la evidencia de Skillstore.
Por qué esta variante es la primera
github-documentation-writer
2026-09-09
c0ntr0lledcha0s-documentation-writer
2026-09-09
Puntuación de Skillstore
Por qué esta puntuación Confianza de la evidencia: AltoLo que puedes crear
Planificar tutoriales de producto
Crear un esquema y un borrador centrados en el aprendizaje para usuarios que necesitan un primer éxito guiado.
Escribir guías prácticas operativas
Convertir una tarea específica en una secuencia clara de pasos con alcance y requisitos previos.
Redactar páginas de referencia
Organizar datos técnicos en material de referencia conciso para consultas repetidas y mantenimiento.
Prueba estos prompts
Necesito documentación para [product or feature]. Ayúdame a elegir si debería ser un tutorial, una guía práctica, una página de referencia o una explicación. Haz primero cualquier pregunta aclaratoria.
Crea un esquema basado en Diataxis para un [document type] sobre [topic]. La audiencia objetivo es [audience], el objetivo es [goal] y el alcance es [scope].
Usa el esquema aprobado para escribir el documento Markdown completo. Mantén el lenguaje simple, preciso y coherente con los detalles del producto proporcionados.
Revisa estos borradores de documentación para comprobar su alineación con Diataxis. Identifica propósitos mezclados, contexto de audiencia faltante, problemas de alcance e incoherencias terminológicas antes de proponer revisiones.
Mejores prácticas
- Proporciona la audiencia objetivo, el objetivo del usuario, el alcance y el tipo de documento al inicio.
- Revisa y aprueba el esquema propuesto antes de solicitar el borrador final.
- Comparte documentación existente cuando el tono, la terminología o la estructura deban coincidir.
Evitar
- Solicitar un documento completo sin detalles del producto ni un objetivo de usuario claro.
- Mezclar objetivos de tutorial, referencia y explicación en una sola página.
- Pedir investigación externa sin proporcionar enlaces confiables o instrucciones.