Fähigkeiten documentation-and-adrs
📦

documentation-and-adrs

Inhaltsrevision r2 Sicher ⚙️ Externe Befehle

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.

Unterstützt: Claude Codex Code(CC)
Maintain this Skill? Claim it 🥉 78 Bronze

Mit meinem Agent installieren

Kopieren Sie diese Anfrage in Ihren Agent. Sie enthält die maßgebliche Skill-Seite und das Manifest.

Agent-Anfrage
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.

Ihr Agent sollte weiterhin seinen Plan anzeigen und alle von der Sicherheitsrichtlinie verlangten Bestätigungen anfordern.

Agent-lesbare Ressourcen

Verwenden Sie diese Links, wenn ein KI-Agent, Crawler oder Skript sauberen Kontext benötigt, statt die vollständige Seite zu lesen.

Markdown-Detailseite GET /skills/addyosmani-documentation-and-adrs.md Signiertes manifest GET /api/skills/addyosmani-documentation-and-adrs/manifest Signiertes lockfile GET /api/skills/addyosmani-documentation-and-adrs/lockfile

Testen

„documentation-and-adrs“ wird verwendet. We chose PostgreSQL over SQLite and MongoDB for a multi-user task application.

Erwartetes Ergebnis:

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

„documentation-and-adrs“ wird verwendet. Document a task creation endpoint that requires a title and returns an identifier.

Erwartetes Ergebnis:

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

„documentation-and-adrs“ wird verwendet. Create onboarding documentation for a project with a development server and test suite.

Erwartetes Ergebnis:

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

Sicherheitsaudit

Sicher
v2 • 19.9.2026 Versionsbericht öffnen

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.

1
Gescannte Dateien
289
Analysierte Zeilen
0
Prüfelemente
0
Falschmeldungen ignoriert

Risikofaktoren

⚙️ Externe Befehle (28)
SKILL.md:38 SKILL.md:40 SKILL.md:41 SKILL.md:48 SKILL.md:50-91 SKILL.md:91-95 SKILL.md:95-97 SKILL.md:97-108 SKILL.md:108-120 SKILL.md:120-124 SKILL.md:124-135 SKILL.md:135-139 SKILL.md:139-150 SKILL.md:150-158 SKILL.md:158-174 SKILL.md:174-178 SKILL.md:178-198 SKILL.md:198-204 SKILL.md:204-211 SKILL.md:211-212 SKILL.md:212-213 SKILL.md:213-218 SKILL.md:218-219 SKILL.md:219-220 SKILL.md:220-221 SKILL.md:221-229 SKILL.md:229-235 SKILL.md:235-248
Das letzte abgeschlossene statische und semantische Audit erkannte keine bestätigten Sicherheitsbefunde. Dies beweist nicht, dass der Skill keine Nebenwirkungen hat.
Geprüft von: codex Audit-Verlauf anzeigen →
Diesen Bericht teilen & zitieren

Teile den versionierten Bewertungsbericht, das neutrale Badge, die Einbettungskarte und Zitate. Skillstore berichtet Nachweise, ohne zu entscheiden, ob dieser Skill sicher ist.

Versionsbericht öffnen
Sicherheitsbewertung

Berichtslink kopieren

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

Markdown-Badge

[![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)

HTML-Badge

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

Einbettungskarte

<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>
Wissenschaftliche Zitate (APA · BibTeX · CFF)

APA-Zitat

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

BibTeX-Zitat

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

Skillstore-Score

Warum dieser Score Evidenzvertrauen: Hoch
55
Architektur
85
Wartbarkeit
87
Inhalt
67
Gemeinschaft
83
Spezifikationskonformität

Was Sie erstellen können

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.

Diese Prompts ausprobieren

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.

Bewährte Praktiken

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

Vermeiden

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

Häufig gestellte Fragen

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.

Entwicklerdetails

Lizenz

MIT

Skillstore-Revision

r2

Versionshinweis

Der Autor hat keine Version angegeben.

Repository

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

Ref.

5d5054f8a23586f9b500fece1cb613a9dffc787b

Aktualität der Wartung

19.9.2026

Nutzung

2 Downloads · 0 Aufrufe

Dateistruktur

📄 SKILL.md