スキル documentation-and-adrs

📦

documentation-and-adrs

Name: documentation-and-adrs
Author: addyosmani

コンテンツリビジョン r2 安全 ⚙️ 外部コマンド

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.

対応: Claude Codex Code(CC)

🥉 78 ブロンズ

自分のエージェントでインストール

このリクエストをエージェントにコピーしてください。正規の Skill ページとマニフェストが含まれています。

エージェントリクエスト

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.

エージェントは引き続き計画を提示し、セキュリティポリシーで必要な確認を求める必要があります。

エージェントが読めるリソース

AI エージェント、クローラー、スクリプトがページ全体ではなく整理されたコンテキストを必要とする場合は、これらのリンクを使ってください。

Markdown詳細 GET /skills/addyosmani-documentation-and-adrs.md 署名済み manifest GET /api/skills/addyosmani-documentation-and-adrs/manifest 署名済み lockfile GET /api/skills/addyosmani-documentation-and-adrs/lockfile

テストする

「documentation-and-adrs」を使用しています。 We chose PostgreSQL over SQLite and MongoDB for a multi-user task application.

期待される結果:

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

「documentation-and-adrs」を使用しています。 Document a task creation endpoint that requires a title and returns an identifier.

期待される結果:

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

「documentation-and-adrs」を使用しています。 Create onboarding documentation for a project with a development server and test suite.

期待される結果:

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.

セキュリティ監査

安全

v2 • 2026/9/19 バージョン別レポートを開く

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.

スキャンされたファイル

289

解析済み行数

レビュー項目

誤検知を無視

最新の完了済み静的・セマンティック監査では、確認済みのセキュリティ検出事項は見つかりませんでした。これは、スキルに副作用がないことを証明するものではありません。

監査者: codex 監査履歴を表示 →

このレポートを共有・引用

バージョン付き評価レポート、中立的なバッジ、埋め込みカード、引用を共有できます。Skillstore は証拠を報告しますが、この Skill が安全かどうかは判断しません。

バージョン別レポートを開く

レポートリンクをコピー

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

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)

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>

埋め込みカード

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

学術引用 (APA · BibTeX · CFF)

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

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"

Skillstore スコア

このスコアの理由証拠の信頼度: 高

アーキテクチャ

保守性

コンテンツ

コミュニティ

仕様準拠

作成できるもの

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.

これらのプロンプトを試す

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.

ベストプラクティス

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.

回避

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.

よくある質問

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.

開発者情報

作成者

addyosmani

ライセンス

MIT

Skillstore リビジョン

バージョンに関する注意

作者はバージョンを宣言していません。

リポジトリ

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

参照

5d5054f8a23586f9b500fece1cb613a9dffc787b

メンテナンスの新しさ

2026/9/19

利用状況

2 ダウンロード · 0 閲覧

ファイル構成

📄 SKILL.md

documentation-and-adrs

自分のエージェントでインストール

エージェントが読めるリソース

テストする

セキュリティ監査

リスク要因

レポートリンクをコピー

Markdownバッジ

HTMLバッジ

埋め込みカード

APA形式の引用

BibTeX形式の引用

CITATION.cff

Skillstore スコア

作成できるもの

Record an architecture decision

Document a public API

Improve project onboarding

これらのプロンプトを試す

ベストプラクティス

回避

よくある質問

開発者情報