documentation-and-adrs
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.
使用我的智能体安装
将此请求复制给你的智能体，其中包含权威 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.你的智能体仍应展示其计划，并按安全策略请求必要确认。
Agent 可读资源
当 AI Agent、爬虫或脚本需要干净上下文，而不是读取完整页面时，请使用这些链接。
测试它
正在使用“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.
安全审计
安全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.
风险因素
⚙️ 外部命令 (28)
分享与引用此报告
分享版本化评估报告、中性徽章、嵌入卡片和引用。Skillstore 只报告证据，不判断该 Skill 是否安全。
复制报告链接
https://skillstore.io/skills/addyosmani-documentation-and-adrs/audits/2?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_reportMarkdown 徽章
[](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/2BibTeX 引用
@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.
试试这些提示
Create a concise ADR for this decision: [decision]. Include context, selected approach, two alternatives, consequences, status, and date. Use clear headings.
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.
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.
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?
Can it find the correct ADR format?
Does it write files automatically?
Can it validate API behavior?
Who benefits most from this skill?
How should generated documentation be reviewed?
开发者详情
作者
addyosmani许可证
MIT
Skillstore 修订
r2
版本提示
作者未声明版本。
引用
5d5054f8a23586f9b500fece1cb613a9dffc787b
维护新鲜度
2026/9/19
使用量
2 次下载 · 0 次浏览
文件结构
📄 SKILL.md