跳到主内容
智客 ZICQ

技能库 智客分类:文档办公 oo-component-documentation

Oo Component Documentation

使用共享模板和针对特定模式的指南创建或更新面向对象的标准化组件文档.

1784 安装量

官方网址:skills.sh

技能介绍

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

做什么

使用共享模板和针对特定模式的指南创建或更新面向对象的标准化组件文档.

何时用

官方 description 未单独写出 Use when。按规范,代理会在用户任务与这段 description 的关键词匹配时激活本技能。

代理如何加载

按 Agent Skills 渐进披露:启动时只加载 name 与 description(约 100 token);任务匹配后才读入整份 SKILL.md 正文;scripts/、references/、assets/ 仅在需要时再读。 本文件正文结构:OO Component Documentation、Determine the mode first、Documentation standards、Shared analysis guidance、Shared output requirements、Language-specific optimizations。 其中含规范建议的小节:分步指令。

文件分析

文件分析:除 SKILL.md 外,正文引用了 references/update-mode.md、references/create-mode.md、assets/documentation-template.md,属于带资源的技能包,这些文件按需再读。

官方 description(原文)

Create or update standardized object-oriented component documentation using a shared template plus mode-specific guidance for new and existing docs.

OO Component DocumentationDetermine the mode firstDocumentation standardsShared analysis guidanceShared output requirementsLanguage-specific optimizationsError handlingWorkflowCompletion criteria

来源分类:skills.sh agent-skill

SKILL.md 与 Agent 调用

官方规范 ↗
name
oo-component-documentation
description
Create or update standardized object-oriented component documentation using a shared template plus mode-specific guidance for new and existing docs.
  1. 发现技能客户端向 Agent 提供名称与描述目录。
  2. 匹配与调用用户指定或任务匹配后,载入 SKILL.md 指令。
  3. 按需加载按步骤读取参考文档、使用脚本与素材。
指令中引用的文件 · 3
  • references/update-mode.md
  • references/create-mode.md
  • assets/documentation-template.md

以下路径提取自原文;文件是否齐全请以来源仓库中的完整目录为准。

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

安装这个技能

Skills CLI ↗

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

该技能引用了附属文件,请从来源获取完整目录;仅复制 SKILL.md 可能缺少依赖。

交给 Agent 安装

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

把 Agent Skill「oo-component-documentation」安装到我的项目:SKILL.md 原文与官方 description 见 https://zicq.com/zh/skills/skl-60e881cfc92d9be6-OO-%E7%BB%84%E4%BB%B6%E6%96%87%E6%A1%A3.html
请存为 .cursor/skills/oo-component-documentation/SKILL.md 或 .claude/skills/oo-component-documentation/SKILL.md,frontmatter 的 name 与 description 保持原样,不要改写。
该技能还带 scripts/、references/、assets/ 等文件,请从 https://github.com/github/awesome-copilot 取完整目录,不要只建一个 SKILL.md。

GitHub 完整包 ↗

终端安装 · Skills CLI

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

npx skills add 'https://github.com/github/awesome-copilot' --list

npx skills add 'https://github.com/github/awesome-copilot' --skill 'oo-component-documentation'

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

阅读排版

name: oo-component-documentation description: 'Create or update standardized object-oriented component documentation using a shared template plus mode-specific guidance for new and existing docs.'

OO Component Documentation

Create new documentation for an object-oriented component or update an existing component documentation file by analyzing the current implementation.

Determine the mode first

Choose the workflow before writing anything:

  1. Use update mode when the user provides an existing documentation Markdown file, points to a docs path, or explicitly asks to refresh or revise existing documentation. Follow references/update-mode.md.
  2. Use create mode when the user provides a source file or folder, points to a component path, or asks to generate documentation from code. Follow references/create-mode.md.
  3. If both code and an existing documentation file are provided, treat the existing documentation file as the output target and use the current source code as the source of truth.
  4. If the request is ambiguous, infer the mode from the path type whenever possible: existing Markdown documentation file means update mode; source/component path means create mode.

Documentation standards

  • DOC-001: Follow C4 Model documentation levels (Context, Containers, Components, Code)
  • DOC-002: Align with Arc42 software architecture documentation template
  • DOC-003: Comply with IEEE 1016 Software Design Description standard
  • DOC-004: Use Agile Documentation principles (just enough documentation that adds value)
  • DOC-005: Target developers and maintainers as the primary audience

Shared analysis guidance

  • ANA-001: Determine the primary component boundary and whether the input represents a folder, file, or existing documentation target
  • ANA-002: Examine source code files for class structures, inheritance, composition, and interfaces
  • ANA-003: Identify design patterns, architectural decisions, and integration points
  • ANA-004: Document or refresh public APIs, interfaces, dependencies, and usage patterns
  • ANA-005: Capture method parameters, return values, asynchronous behavior, exceptions, and lifecycle concerns
  • ANA-006: Assess performance, security, reliability, maintainability, and extensibility characteristics
  • ANA-007: Infer data flow, collaboration patterns, and relationships with surrounding components
  • ANA-008: Keep the documentation grounded in the implementation; avoid inventing behavior that is not supported by the code

Shared output requirements

  • Use assets/documentation-template.md as the canonical section checklist and baseline structure.
  • Keep the output in Markdown with a clear heading hierarchy, tables where useful, code blocks for examples, and Mermaid diagrams when architecture relationships need to be visualized.
  • Make examples and interface descriptions match the current implementation instead of generic placeholders.
  • Include only information that can be supported by the code, project structure, configuration, or clearly stated assumptions.
  • When source coverage is incomplete, document the limitation explicitly instead of guessing.

Language-specific optimizations

  • LNG-001: C#/.NET - async/await, dependency injection, configuration, disposal, options patterns
  • LNG-002: Java - Spring framework, annotations, exception handling, packaging, dependency injection
  • LNG-003: TypeScript/JavaScript - modules, async patterns, types, npm dependencies, runtime boundaries
  • LNG-004: Python - packages, virtual environments, type hints, testing, dependency management

Error handling

  • ERR-001: If the path does not exist, explain what path was expected and whether the skill needs a source path or an existing documentation file
  • ERR-002: If no relevant source files are found, document the gap and suggest the likely locations to inspect next
  • ERR-003: If the documentation target cannot be inferred from the request, state the ambiguity and ask for the missing path only when inference is not possible
  • ERR-004: If the code uses non-standard architectural patterns, document the custom approach rather than forcing it into a generic pattern
  • ERR-005: If source access is incomplete, continue with available evidence and clearly call out any unsupported sections

Workflow

  1. Determine whether the task is create mode or update mode.
  2. Inspect the component implementation and any related files needed to understand its public surface area and internal structure.
  3. Use assets/documentation-template.md as the shared documentation scaffold.
  4. Apply the mode-specific rules in references/create-mode.md or references/update-mode.md.
  5. Produce or revise the documentation so that diagrams, examples, interfaces, dependencies, and quality attributes reflect the current implementation.

Completion criteria

  • The documentation clearly identifies the component purpose, architecture, interfaces, implementation details, usage patterns, quality attributes, and references.
  • Front matter fields are accurate for the selected mode.
  • Examples and diagrams match the implementation.
  • Any unknowns, gaps, or assumptions are explicitly called out.

相关技能

文档办公

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,归档一个问题,更新一个电子表格,通过一个连接的搜索或刮取提供者运行一个查询. 每一次通话都到用户连接的应用…