Habilidades documentation-and-adrs

📦

documentation-and-adrs

Name: documentation-and-adrs
Author: addyosmani

Revisão do conteúdo r2 Seguro ⚙️ Comandos externos

Document Decisions and Architecture Clearly

Teams lose context when important technical decisions remain in chat, code comments, or individual memory. This skill turns architectural reasoning, API guidance, project instructions, and release changes into structured documentation.

Suporta: Claude Codex Code(CC)

🥉 78 Bronze

Instalar com meu Agente

Copie esta solicitação para o seu Agente. Ela inclui a página canônica do Skill e o manifesto.

Solicitação do 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.

Seu Agente ainda deve apresentar o plano e solicitar qualquer confirmação exigida pela política de segurança.

Recursos legíveis por agentes

Use estes links quando um agente de IA, crawler ou script precisar de contexto limpo em vez de ler a página completa.

Detalhe em Markdown GET /skills/addyosmani-documentation-and-adrs.md manifest assinado GET /api/skills/addyosmani-documentation-and-adrs/manifest lockfile assinado GET /api/skills/addyosmani-documentation-and-adrs/lockfile

Testar

Usando "documentation-and-adrs". We chose PostgreSQL over SQLite and MongoDB for a multi-user task application.

Resultado esperado:

An ADR outline with status, context, relational data requirements, alternatives considered, the PostgreSQL decision, and operational consequences.

Usando "documentation-and-adrs". Document a task creation endpoint that requires a title and returns an identifier.

Resultado esperado:

API reference guidance covering the request fields, validation errors, authentication expectations, response details, and a short usage example.

Usando "documentation-and-adrs". Create onboarding documentation for a project with a development server and test suite.

Resultado esperado:

A README structure covering project purpose, setup, commands, architecture, and contribution practices.
A verification checklist for setup instructions, API documentation, known gotchas, and current agent rules.

Auditoria de segurança

Seguro

v2 • 19/09/2026 Abrir o relatório versionado

All 28 external-command detections are Markdown examples or inline command references in SKILL.md, not executable behavior. The environment-file and system-reconnaissance detections also point to documentation examples, and no prompt injection or data-exfiltration intent was found.

Arquivos analisados

289

Linhas analisadas

Itens de revisão

Falsos positivos ignorados

A auditoria estática e semântica concluída mais recente não detectou achados de segurança confirmados. Isso não comprova que a skill não tenha efeitos colaterais.

Auditado por: codex Ver histórico de auditoria →

Compartilhar e citar este relatório

Compartilhe o relatório de avaliação versionado, o badge neutro, o cartão incorporável e as citações. A Skillstore apresenta evidências sem decidir se este Skill é seguro.

Abrir o relatório versionado

Copiar link do relatório

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

Badge 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)

Badge 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>

Cartão incorporável

<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>

Citações acadêmicas (APA · BibTeX · CFF)

Citação APA

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

Citação BibTeX

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

Pontuação do Skillstore

Por que esta pontuação Confiança das evidências: Alto

Arquitetura

Manutenibilidade

Conteúdo

Comunidade

Conformidade com a especificação

O que você pode criar

Record an architecture decision

Create an ADR that compares options, explains trade-offs, records the selected approach, and preserves consequences for future maintainers.

Document a public API

Draft consistent API documentation covering inputs, outputs, errors, authentication expectations, and representative usage guidance.

Improve project onboarding

Build a practical README, changelog structure, and agent guidance so contributors can understand setup, architecture, conventions, and recent changes.

Teste estes prompts

Draft a simple ADR

Create a concise ADR for this decision: [decision]. Include context, selected approach, two alternatives, consequences, status, and date. Use clear headings.

Match repository conventions

Review the repository context I provide and identify its ADR location, file format, numbering pattern, and headings. Then draft an ADR for [decision] that follows those conventions.

Document a public API

Write documentation for this public API: [API details]. Cover parameters, return values, validation, authentication, errors, and one realistic example. State unknowns instead of inventing behavior.

Build a documentation system

Design a documentation update for [project]. Propose ADRs for durable decisions, README sections for onboarding, API reference coverage, changelog entries, agent guidance, and a verification checklist. Preserve existing conventions and identify missing evidence.

Boas práticas

Provide repository conventions and factual project context before requesting documentation.
Document the reasoning, constraints, alternatives, and consequences instead of restating implementation details.
Review every generated command, example, link, and security statement against the current project.

Evitar

Do not invent repository conventions, API behavior, commands, or architectural constraints.
Do not create duplicate ADR numbering schemes or replace established project formats without evidence.
Do not use documentation as a substitute for implementation, testing, access control, or operational validation.

Perguntas frequentes

What does this skill create?

It creates ADRs, API documentation, README structures, changelog guidance, and documentation plans for human and AI contributors.

Can it find the correct ADR format?

Yes, when you provide repository context. It can identify existing locations, naming patterns, file formats, and section headings.

Does it write files automatically?

No. It produces documentation content and recommendations. The surrounding agent must review and apply file changes.

Can it validate API behavior?

No. It can organize supplied API facts, but it cannot test endpoints or confirm undocumented implementation behavior.

Who benefits most from this skill?

Engineering leads, API maintainers, open-source maintainers, developer experience teams, and agents working in unfamiliar repositories.

How should generated documentation be reviewed?

Check decisions, commands, links, examples, security claims, project conventions, and dates against the current repository before publishing.

Detalhes do desenvolvedor

Autor

addyosmani

Licença

MIT

Revisão da Skillstore

Aviso de versão

O autor não declarou uma versão.

Repositório

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

Referência

5d5054f8a23586f9b500fece1cb613a9dffc787b

Atualidade da manutenção

19/09/2026

Uso

2 downloads · 0 visualizações

Estrutura de arquivos

📄 SKILL.md

documentation-and-adrs

Instalar com meu Agente

Recursos legíveis por agentes

Testar

Auditoria de segurança

Fatores de risco

Copiar link do relatório

Badge Markdown

Badge HTML

Cartão incorporável

Citação APA

Citação BibTeX

CITATION.cff

Pontuação do Skillstore

O que você pode criar

Record an architecture decision

Document a public API

Improve project onboarding

Teste estes prompts

Boas práticas

Evitar

Perguntas frequentes

Detalhes do desenvolvedor