Habilidades documentation-and-adrs

📦

documentation-and-adrs

Name: documentation-and-adrs
Author: addyosmani

Revisión del contenido r1 Seguro ⚙️ Comandos externos

Document Architecture Decisions Clearly

Teams can lose important reasoning when decisions remain only in code or chat messages. This skill provides structured guidance for ADRs, API documentation, changelogs, and project conventions.

Compatible con: Claude Codex Code(CC)

🥉 77 Bronce

Instalar con mi Agente

Copia esta solicitud en tu Agente. Incluye la página canónica del Skill y el manifiesto.

Solicitud de agente

Review the Skillstore skill "documentation-and-adrs" from https://skillstore.io/skills/addyosmani-documentation-and-adrs.md and its manifest at https://skillstore.io/api/skills/addyosmani-documentation-and-adrs/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.

Detalle Markdown GET /skills/addyosmani-documentation-and-adrs.md Manifest firmado GET /api/skills/addyosmani-documentation-and-adrs/manifest Lockfile firmado GET /api/skills/addyosmani-documentation-and-adrs/lockfile

Pruébalo

Usando "documentation-and-adrs". Draft an ADR for adopting a message queue.

Resultado esperado:

Title: Adopt a managed message queue
Status: Proposed
Context: Background jobs need reliable asynchronous processing.
Decision: Use a managed queue service with documented retry policies.
Consequences: Operations are simplified, but the service adds cost and vendor dependency.

Usando "documentation-and-adrs". Document a breaking API rename.

Resultado esperado:

API change: Rename createUser to registerUser.
Migration: Update callers to use registerUser before the next major release.
Changelog: Mark the old name as removed and link to the migration guide.

Auditoría de seguridad

Seguro

v1 • 30/8/2026 Abrir el informe versionado

All 30 static findings are false positives caused by Markdown code formatting, documentation examples, and a TypeScript example. The skill contains no executable scripts, secret access, network activity, destructive behavior, or prompt-injection content.

Archivos escaneados

289

Líneas analizadas

Elementos de revisión

Falsos positivos ignorados

La auditoría estática y semántica completada más reciente no detectó hallazgos de seguridad confirmados. Esto no demuestra que el skill no tenga efectos secundarios.

Auditado por: claude

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.

Abrir el informe versionado

Copiar enlace del informe

https://skillstore.io/skills/addyosmani-documentation-and-adrs/audits/1?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_report

Insignia Markdown

[![Skillstore security assessment](https://skillstore.io/badges/skills/addyosmani-documentation-and-adrs/security.svg)](https://skillstore.io/skills/addyosmani-documentation-and-adrs?utm_source=security_passport_badge)

Insignia HTML

<a href="https://skillstore.io/skills/addyosmani-documentation-and-adrs?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/addyosmani-documentation-and-adrs/security.svg" alt="Skillstore security assessment" loading="lazy"></a>

Tarjeta para insertar

<iframe src="https://skillstore.io/embed/skills/addyosmani-documentation-and-adrs.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

addyosmani. (2026). documentation-and-adrs security audit report (audit version 1) [Author version unspecified]. Skillstore. https://skillstore.io/skills/addyosmani-documentation-and-adrs/audits/1

Cita BibTeX

@techreport{addyosmani-addyosmani-documentation-and-adrs-2026,
  author = {addyosmani},
  title = {documentation-and-adrs security audit report (audit version 1)},
  institution = {Skillstore},
  year = {2026},
  number = {1},
  url = {https://skillstore.io/skills/addyosmani-documentation-and-adrs/audits/1},
  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-and-adrs security audit report (audit version 1)"
version: "unspecified"
type: report
authors:
  - name: "addyosmani"
date-released: "2026-08-30"
url: "https://skillstore.io/skills/addyosmani-documentation-and-adrs/audits/1"
identifiers:
  - type: other
    value: "skillstore:addyosmani-documentation-and-adrs:audit:1"
    description: "Skillstore immutable audit report identifier"

Puntuación de Skillstore

Por qué esta puntuación Confianza de la evidencia: Medio

Arquitectura

Mantenibilidad

Contenido

Comunidad

Cumplimiento de la especificación

Lo que puedes crear

Record an architecture choice

Create an ADR that explains a significant technical decision, its context, and its consequences.

Document a public API change

Add clear API documentation and release notes when a feature changes a public interface.

Preserve project context

Capture conventions and implementation reasoning so future contributors can work consistently.

Prueba estos prompts

Create a first ADR

Help me draft an ADR for choosing a database. Include context, decision, alternatives, consequences, and status.

Document an API change

Help me document this public API change. Explain the purpose, parameters, return values, migration steps, and compatibility impact.

Align with repository conventions

Review the existing documentation conventions I provide. Then propose an ADR location, filename, numbering, and headings that match them.

Plan documentation for a release

Create a documentation plan for this release. Include ADR updates, API reference changes, README updates, changelog entries, owners, and review checks.

Mejores prácticas

Inspect existing project conventions before creating documentation.
Record the decision context and alternatives, not only the final choice.
Review documentation when public behavior or architecture changes.

Evitar

Do not create an ADR for a routine implementation detail.
Do not delete historical ADRs when a decision changes; mark them superseded.
Do not write comments that merely repeat what the code already states.

Preguntas frecuentes

What is an ADR?

An Architecture Decision Record explains an important technical decision, its context, and its consequences.

When should I create an ADR?

Create one for decisions that affect architecture, public interfaces, security, operations, or long-term maintenance.

Should I use the included ADR format exactly?

No. Follow the repository format when one already exists.

Can this skill write API documentation?

It can guide clear API documentation with purpose, usage, behavior, and compatibility information.

Does this skill run commands or modify files?

No. It is documentation guidance and contains no executable automation.

How should old ADRs be handled?

Keep them as history and mark them superseded or deprecated when a newer decision replaces them.

Detalles del desarrollador

Autor

addyosmani

Licencia

MIT

Revisión de Skillstore

Aviso de versión

El autor no declaró una versión.

Repositorio

https://github.com/addyosmani/agent-skills/tree/d2c37ef6225dd8726cdd369a8030307f48592d26/skills/documentation-and-adrs

Ref.

c6787a0b49a3d272bbd03c247ea84d5a7617580d

Actualidad del mantenimiento

31/8/2026

Uso

1 descargas · 0 vistas

Estructura de archivos

📄 SKILL.md