跳到主内容
智客 ZICQ

技能库 智客分类:文档办公 documentation-and-adrs

Documentation And Adrs

记录决定和文件。 当您需要记录一个架构决定(ADR)或设计选择背后的推理时,当您需要修改公共API,航运特征时,或者当您需要记录未来工程师和代理商需要理解代码库的上下文时使用.

79139 安装量

官方网址:skills.sh

技能介绍

先看中文介绍;官方 description 原文单独保留,不改写 SKILL.md。

做什么

记录决定和文件

何时用

- 作出重大建筑决定

代理如何加载

按 Agent Skills 渐进披露:启动时只加载 name 与 description(约 100 token);任务匹配后才读入整份 SKILL.md 正文;scripts/、references/、assets/ 仅在需要时再读。 本文件正文结构:Documentation and ADRs、Overview、When to Use、Architecture Decision Records (ADRs)、When to Write an ADR、Match the existing convention first。

文件分析

文件分析:这是一份仅含 SKILL.md 的指令型技能,代理激活后整份正文进入上下文。

官方 description(原文)

Records decisions and documentation. Use when you need to document an architecture decision (ADR) or the reasoning behind a design choice, when changing public APIs, shipping features, or when you need to record context that future engineers and agents will need to understand the codebase.

Documentation and ADRsOverviewWhen to UseArchitecture Decision Records (ADRs)When to Write an ADRMatch the existing convention firstADR TemplateADR-001: Use PostgreSQL for primary databaseStatusDateContextDecision

来源分类:GitHub skill skills.sh agent-skill

SKILL.md 与 Agent 调用

官方规范 ↗
name
documentation-and-adrs
description
Records decisions and documentation. Use when you need to document an architecture decision (ADR) or the reasoning behind a design choice, when changing public APIs, shipping features, or when you need to record context that future engineers and agents will need to understand the codebase.
  1. 发现技能客户端向 Agent 提供名称与描述目录。
  2. 匹配与调用用户指定或任务匹配后,载入 SKILL.md 指令。
  3. 按需加载按步骤读取参考文档、使用脚本与素材。

具体调用语法与可用工具以目标 Agent 客户端为准。 查看调用机制说明 ↗

安装这个技能

Skills CLI ↗

先选择目标 Agent 和安装范围,保留技能包的附属文件,安装后检查客户端能否发现该技能。

交给 Agent 安装

复制安装指令给支持 Agent Skills 的代理,确认其中的目标目录与客户端匹配。

把 Agent Skill「documentation-and-adrs」安装到我的项目:SKILL.md 原文与官方 description 见 https://zicq.com/zh/skills/skl-003ff8feb1ef9ee5-%E6%96%87%E6%A1%A3%E5%92%8CAdrs.html
请存为 .cursor/skills/documentation-and-adrs/SKILL.md 或 .claude/skills/documentation-and-adrs/SKILL.md,frontmatter 的 name 与 description 保持原样,不要改写。

GitHub 完整包 ↗

终端安装 · Skills CLI

需要 Node.js 与 npx。先查看仓库技能列表,确认实际名称。

npx skills add 'https://github.com/addyosmani/agent-skills' --list

npx skills add 'https://github.com/addyosmani/agent-skills' --skill 'documentation-and-adrs'

CLI 会交互选择目标 Agent,默认安装到项目;用户级安装使用 -g。先通过查看命令核对仓库内容,再用 npx skills list 检查已安装技能。

阅读排版
--- name: documentation-and-adrs description: Records decisions and documentation. Use when you need to document an architecture decision (ADR) or the reasoning behind a design choice, when changing public APIs, shipping features, or when you need to record context that future engineers and agents will need to understand the codebase. --- # Documentation and ADRs ## Overview Document decisions, not just code. The most valuable documentation captures the *why* — the context, constraints, and trade-offs that led to a decision. Code shows *what* was built; documentation explains *why it was built this way* and *what alternatives were considered*. This context is essential for future humans and agents working in the codebase. ## When to Use - Making a significant architectural decision - Choosing between competing approaches - Adding or changing a public API - Shipping a feature that changes user-facing behavior - Onboarding new team members (or agents) to the project - When you find yourself explaining the same thing repeatedly **When NOT to use:** Don't document obvious code. Don't add comments that restate what the code already says. Don't write docs for throwaway prototypes. ## Architecture Decision Records (ADRs) ADRs capture the reasoning behind significant technical decisions. They're the highest-value documentation you can write. ### When to Write an ADR - Choosing a framework, library, or major dependency - Designing a data model or database schema - Selecting an authentication strategy - Deciding on an API architecture (REST vs. GraphQL vs. tRPC) - Choosing between build tools, hosting platforms, or infrastructure - Any decision that would be expensive to reverse ### Match the existing convention first Before creating an ADR, inspect the available repository context for an established convention — existing ADRs, project instructions, and ADR-related configuration or tooling (e.g. an `.adr-dir` file). An established convention overrides the defaults below. Match: - **Location and format** — e.g. `docs/adr/*.md`, `Documentation/Decisions/*.rst`, a MADR layout, or an `adr-tools` setup. Match the existing directory, file extension, and markup (Markdown vs reStructuredText). - **Numbering and naming** — continue the existing sequence and filename pattern (`ADR-004-Title.rst`, `0004-title.md`, …); don't restart at 001 or introduce a second scheme. - **Section headings** — reuse the project's heading set rather than imposing this template's. If the available evidence conflicts, surface the conflict rather than silently introducing another scheme. Only when no convention can be established do you apply the default below. ### ADR Template Store ADRs in `docs/decisions/` with sequential numbering (unless the project already uses another location — see above): ```markdown # ADR-001: Use PostgreSQL for primary database ## Status Accepted | Superseded by ADR-XXX | Deprecated ## Date 2025-01-15 ## Context We need a primary database for the task management application. Key requirements: - Relational data model (users, tasks, teams with relationships) - ACID transactions for task state changes - Support for full-text search on task content - Managed hosting available (for small team, limited ops capacity) ## Decision Use PostgreSQL with Prisma ORM. ## Alternatives Considered ### MongoDB - Pros: Flexible schema, easy to start with - Cons: Our data is inherently relational; would need to manage relationships manually - Rejected: Relational data in a document store leads to complex joins or data duplication ### SQLite - Pros: Zero configuration, embedded, fast for reads - Cons: Limited concurrent write support, no managed hosting for production - Rejected: Not suitable for multi-user web application in production ### MySQL - Pros: Mature, widely supported - Cons: PostgreSQL has better JSON support, full-text search, and ecosystem tooling - Rejected: PostgreSQL is the better fit for our feature requirements ## Consequences - Prisma provides type-safe database access and migration management - We can use PostgreSQL's full-text search instead of adding Elasticsearch - Team needs PostgreSQL knowledge (standard skill, low risk) - Hosting on managed service (Supabase, Neon, or RDS) ``` ### ADR Lifecycle ``` PROPOSED → ACCEPTED → (SUPERSEDED or DEPRECATED) ``` - **Don't delete old ADRs.** They capture historical context. - When a decision changes, write a new ADR that references and supersedes the old one. ## Inline Documentation ### When to Comment Comment the *why*, not the *what*: ```typescript // BAD: Restates the code // Increment counter by 1 counter += 1; // GOOD: Explains non-obvious intent // Rate limit uses a sliding window — reset counter at window boundary, // not on a fixed schedule, to prevent burst attacks at window edges if (now - windowStart > WINDOW_SIZE_MS) { counter = 0; windowStart = now; } ``` ### When NOT to Comment ```typescript // Don't comment self-explanatory code function calculateTotal(items: CartItem[]): number { return items.reduce((sum, item) => sum + item.price * item.quantity, 0); } // Don't leave TODO comments for things you should just do now // TODO: add error handling ← Just add it // Don't leave commented-out code // const oldImplementation = () => { ... } ← Delete it, git has history ``` ### Document Known Gotchas ```typescript /** * IMPORTANT: This function must be called before the first render. * If called after hydration, it causes a flash of unstyled content * because the theme context isn't available during SSR. * * See ADR-003 for the full design rationale. */ export function initializeTheme(theme: Theme): void { // ... } ``` ## API Documentation For public APIs (REST, GraphQL, library interfaces): ### Inline with Types (Preferred for TypeScript) ```typescript /** * Creates a new task. * * @param input - Task creation data (title required, description optional) * @returns The created task with server-generated ID and timestamps * @throws {ValidationError} If title is empty or exceeds 200 characters * @throws {AuthenticationError} If the user is not authenticated * * @example * const task = await createTask({ title: 'Buy groceries' }); * console.log(task.id); // "task_abc123" */ export async function createTask(input: CreateTaskInput): Promise { // ... } ``` ### OpenAPI / Swagger for REST APIs ```yaml paths: /api/tasks: post: summary: Create a task requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateTaskInput' responses: '201': description: Task created content: application/json: schema: $ref: '#/components/schemas/Task' '422': description: Validation error ``` ## README Structure Every project should have a README that covers: ```markdown # Project Name One-paragraph description of what this project does. ## Quick Start 1. Clone the repo 2. Install dependencies: `npm install` 3. Set up environment: `cp .env.example .env` 4. Run the dev server: `npm run dev` ## Commands | Command | Description | |---------|-------------| | `npm run dev` | Start development server | | `npm test` | Run tests | | `npm run build` | Production build | | `npm run lint` | Run linter | ## Architecture Brief overview of the project structure and key design decisions. Link to ADRs for details. ## Contributing How to contribute, coding standards, PR process. ``` ## Changelog Maintenance For shipped features: ```markdown # Changelog ## [1.2.0] - 2025-01-20 ### Added - Task sharing: users can share tasks with team members (#123) - Email notifications for task assignments (#124) ### Fixed - Duplicate tasks appearing when rapidly clicking create button (#125) ### Changed - Task list now loads 50 items per page (was 20) for better UX (#126) ``` ## Documentation for Agents Special consideration for AI agent context: - **CLAUDE.md / rules files** — Document project conventions so agents follow them - **Spec files** — Keep specs updated so agents build the right thing - **ADRs** — Help agents understand why past decisions were made (prevents re-deciding) - **Inline gotchas** — Prevent agents from falling into known traps ## Common Rationalizations | Rationalization | Reality | |---|---| | "The code is self-documenting" | Code shows what. It doesn't show why, what alternatives were rejected, or what constraints apply. | | "We'll write docs when the API stabilizes" | APIs stabilize faster when you document them. The doc is the first test of the design. | | "Nobody reads docs" | Agents do. Future engineers do. Your 3-months-later self does. | | "ADRs are overhead" | A 10-minute ADR prevents a 2-hour debate about the same decision six months later. | | "Comments get outdated" | Comments on *why* are stable. Comments on *what* get outdated — that's why you only write the former. | ## Red Flags - Architectural decisions with no written rationale - Public APIs with no documentation or types - README that doesn't explain how to run the project - Commented-out code instead of deletion - TODO comments that have been there for weeks - No ADRs in a project with significant architectural choices - Documentation that restates the code instead of explaining intent ## Verification After documenting: - [ ] ADRs exist for all significant architectural decisions - [ ] README covers quick start, commands, and architecture overview - [ ] API functions have parameter and return type documentation - [ ] Known gotchas are documented inline where they matter - [ ] No commented-out code remains - [ ] Rules files (CLAUDE.md etc.) are current and accurate

相关技能

文档办公

Ontology

为结构化的代理内存和可堆肥技能所打入的知识图. 在创建/征服实体(Person, project, Task, Evention, Document)时使用,链接相关对象,强制约束,规划多步动作作为图变,或技能需要共享状态时使用. 触发到"记住","我知道什么","链接X到Y",…

文档办公

Nano Pdf

使用纳米-pdf CLI编辑带有自然语言指令的PDF.

文档办公

Word / DOCX

创建,检查,并编辑有可靠样式的Microsoft Word文档和DOCX文件,编号,跟踪更改,表格,章节,并进行相容性检查. 当 (1) 任务涉及 Word 或 ".docx " 时使用; (2) 文件包括跟踪的更改,评论,字段,表格,模板,或页面布局限制; (3) 文档必须在不…

文档办公

Api Gateway

通过 Maton 网关调用第三方 API, 它为用户已经连接的应用程序注入证书 。 当用户命名一个连接的应用程序和其中的具体行动时使用此技能——读取一个邮箱,查询一个CMM,归档一个问题,更新一个电子表格,通过一个连接的搜索或刮取提供者运行一个查询. 每一次通话都到用户连接的应用…