Навыки 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 Бронза

Maintain this Skill? Claim it 🥉 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-агентов

Используйте эти ссылки, когда AI-агенту, crawler или script нужен чистый контекст вместо полной страницы.

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 • 19.09.2026 Открыть версионный отчет

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

Актуальность поддержки

19.09.2026

Использование

2 загрузок · 0 просмотров

Структура файлов

📄 SKILL.md

documentation-and-adrs

Установить с помощью моего Агента

Ресурсы для AI-агентов

Протестировать

Аудит безопасности

Факторы риска

Копировать ссылку на отчёт

Значок Markdown

Значок HTML

Встраиваемая карточка

Цитата APA

Цитата BibTeX

CITATION.cff

Оценка Skillstore

Что вы можете построить

Record an architecture decision

Document a public API

Improve project onboarding

Попробуйте эти промпты

Лучшие практики

Избегать

Часто задаваемые вопросы

Сведения для разработчиков