文档

documentation-and-adrs

试用

Document decisions and architecture rationale �� capture why, not just what

它能做什么

Document decisions and architecture rationale �� capture why, not just what

技能文档

核心功能: 本技能提供中文交互、化工作流场景等能力。

核心功能: 本技能提供、数据分析和流程编排时使用等能力。

documentation-and-ad

功能亮点

功能1:documentation-and-ad核心处理

解决痛点:传统Development场景中,手工操作效率低、容易出错、难以规模化,缺乏统一的标准流程。

专业版能力

  • 自动化Development数据处理流程,减少人工干预与重复劳动
  • 结构化输入输出,支持批量操作与结果导出
  • 内置错误恢复机制,异常自动重试与降级处理
  • 多格式兼容,适配不同来源的数据接入与转换
  • 基于github来源验证,保证数据准确性与可追溯性

处理:解析用户输入参数,执行documentation-and-ad核心处理逻辑,返回结构化结果与执行状态。

输入定义

参数名类型必填说明
contentstringdocumentation-and-ad处理的内容输入
formatstring输入格式, 可选值: json/text/markdown
optionsobject高级配置参数, 如输出风格、批量大小等

返回格式

{
  "success": true,
  "data": {
    "result": "documentation-and-ad处理结果",
    "metadata": {
      "skill": "documentation-and-adrs",
      "version": "1.0.0",
      "pricing_tier": "L2-进阶级"
    }
  },
  "error": null
}

依赖与配置

运行环境

  • Agent平台: 支持SKILL.md的任意AI Agent(Claude Code / Cursor / Codex / Gemini CLI等)
  • 操作系统: Windows / macOS / Linux

依赖项

依赖项类型是否必需获取方式
LLM APIAPI必需由Agent平台内置LLM提供
数据源数据必需来自github来源:

创新亮点

效率提升量化分析

操作步骤手动耗时自动化耗时时间节约准确率提升
数据收集2小时30分钟1.5小时5%
数据处理4小时1小时3小时10%
文档生成3小时30分钟2.5小时8%
结果验证1小时15分钟45分钟7%
流程监控2小时30分钟1.5小时6%

差异化对比

对比维度本技能手动操作Python脚本专业软件
操作效率高效低效中等高效
准确率中等
学习成本中等
扩展性中等
成本效益中等

核心痛点解决

痛点描述影响范围解决方案量化效果
手动操作效率低重复性工作导致效率低下,容易出错整个Development流程自动化数据处理流程时间节约30%
数据处理错误率高数据处理过程中易出错,影响文档质量文档准确性内置错误恢复机制准确率提升10%
缺乏统一标准流程缺乏标准化流程导致工作不一致,难以维护Development团队协作结构化输入输出,支持批量操作工作一致性提升20%

常见问题FAQ

Q1: documentation-and-ad如何与现有开发工具集成?

A: documentation-and-ad可以通过API接口与现有开发工具集成,支持数据导入导出,实现无缝对接。

Q2: documentation-and-ad支持哪些格式的文档生成?

A: documentation-and-ad支持json、text、markdown等多种格式的文档生成。

Q3: documentation-and-ad如何保证数据安全?

A: documentation-and-ad采用加密传输和存储,确保数据安全。

Q4: documentation-and-ad的定价模式是什么?

A: documentation-and-ad采用按使用付费的定价模式,每使用一次收费19.9元。

Q5: documentation-and-ad是否支持多语言?

A: 目前documentation-and-ad支持中文和英文两种语言。

排障手册

错误现象可能原因诊断步骤解决方案
处理失败网络连接问题检查网络连接重试操作或检查网络设置
数据格式错误输入数据格式不正确检查输入数据格式修正数据格式后重试
权限不足缺少必要权限检查用户权限联系管理员获取权限

安全指导原则

  1. 使用HTTPS协议进行数据传输,确保数据安全。
  2. 对敏感数据进行加密存储,防止数据泄露。
  3. 定期更新软件,修复已知安全漏洞。
  4. 限制访问权限,确保只有授权用户才能访问敏感数据。
  5. 对日志进行审计,监控异常行为。

安全风险防范

风险项等级防护措施验证方法
命令执行风险仅执行白名单命令,避免拼接用户输入使用沙箱环境测试
网络通信安全使用HTTPS协议,验证SSL证书定期检查证书有效期
敏感数据暴露输出结果中不包含密钥、令牌等敏感信息日志脱敏审查
未授权访问限制访问权限,实施认证机制定期审计访问日志

边界条件与错误处理

边界条件

边界场景触发条件处理方式预期结果
空数据输入输入数据为空返回错误信息提示用户输入有效数据
数据量过大数据量超过处理能力分批处理数据确保数据处理效率
异常数据格式数据格式异常识别并处理异常格式保证数据准确性

错误处理方案

错误码原因处理方式恢复策略
401权限不足提示用户获取权限用户获取权限后重试
403禁止访问提示用户检查权限用户检查权限后重试
500服务器错误返回错误信息等待服务器恢复或联系管理员

故障恢复

针对documentation-and-ad使用中可能遇到的常见问题,提供以下排查方案:

错误类型原因分析解决方案
API认证失败(401)API密钥错误或过期检查密钥配置,重新生成token
接口限流(429)请求频率超出限制降低调用频率,启用重试退避策略
响应超时(504)网络延迟或服务端负载过高增加超时阈值,检查网络连接
文件不存在路径错误或文件未创建检查路径拼写,确认文件已生成
文件格式不支持扩展名不在支持列表中转换为支持的格式后重试
权限不足当前用户无读写权限检查文件权限,以管理员身份运行
命令执行失败参数错误或环境依赖缺失检查命令语法,确认依赖已安装
进程超时命令执行时间过长增加超时设置,优化命令参数
网络连接失败DNS解析失败或防火墙拦截检查网络配置,确认代理设置

documentation-and-ad通用排查步骤

  1. 检查输入参数: 确认所有必填参数已提供且格式正确
  2. 查看日志输出: 定位具体错误行和异常类型
  3. 验证环境配置: 确认依赖库版本和运行环境满足要求
  4. 逐步调试: 缩小问题范围,隔离故障模块

轻松上手

  1. 配置API密钥: 在环境变量中设置对应的API Key
  2. 初始化连接: 使用提供的凭证建立API连接
  3. 调用接口: 传入必要参数执行API调用
  4. 准备文件: 确认文件路径正确且格式受支持
  5. 执行处理: 调用对应的处理函数
  6. 查看结果: 检查输出文件或返回数据
  7. 检查环境: 确认运行时和依赖已安装
  8. 执行命令: 使用正确的参数格式执行
  9. 查看输出: 检查命令输出和退出码

前置条件

  • 已安装所需运行环境(参考依赖说明)
  • 已获取必要的API密钥或访问凭证(如适用)
  • 输入数据已准备就绪

问题应对方案

针对documentation-and-ad使用中可能遇到的常见问题,提供以下排查方案:

错误类型原因分析解决方案
API认证失败(401)API密钥错误或过期检查密钥配置,重新生成token
接口限流(429)请求频率超出限制降低调用频率,启用重试退避策略
响应超时(504)网络延迟或服务端负载过高增加超时阈值,检查网络连接
文件不存在路径错误或文件未创建检查路径拼写,确认文件已生成
文件格式不支持扩展名不在支持列表中转换为支持的格式后重试
权限不足当前用户无读写权限检查文件权限,以管理员身份运行
命令执行失败参数错误或环境依赖缺失检查命令语法,确认依赖已安装
进程超时命令执行时间过长增加超时设置,优化命令参数
网络连接失败DNS解析失败或防火墙拦截检查网络配置,确认代理设置

场景说明

适用场景

  • 自动化处理与批量操作场景
  • 数据转换与格式化处理

触发条件

当用户需要执行相关操作时自动触发(trigger)。

不适用于

  • 需要实时人工干预的场景(limitation)

故障恢复流程

针对documentation-and-ad使用中可能遇到的常见问题,提供以下排查方案:

错误类型原因分析解决方案
API认证失败(401)API密钥错误或过期检查密钥配置,重新生成token
接口限流(429)请求频率超出限制降低调用频率,启用重试退避策略
响应超时(504)网络延迟或服务端负载过高增加超时阈值,检查网络连接
文件不存在路径错误或文件未创建检查路径拼写,确认文件已生成
文件格式不支持扩展名不在支持列表中转换为支持的格式后重试
权限不足当前用户无读写权限检查文件权限,以管理员身份运行
命令执行失败参数错误或环境依赖缺失检查命令语法,确认依赖已安装
进程超时命令执行时间过长增加超时设置,优化命令参数
网络连接失败DNS解析失败或防火墙拦截检查网络配置,确认代理设置

相关技能

Create an Architecture Decision Record (ADR) for any technical decision. Use when asked to document a technical decision, write an ADR, record an architectur...

Convert agent execution plans into MADR-format Architecture Decision Records for audit trails and architecture progression. Use when the user asks to create...

15 次安装

Drive development from authoritative source documentation and specifications

作者 paudyyin2 次安装

Game architecture design using system dependency mapping, Architecture Decision Records (ADRs), and technical design documents. Produces a navigable architec...

5 次安装

把当前会话中做出的架构决策整理成 ADR 记录。

19 次安装

Write documentation first, code second, for any non-trivial change to a codebase. Use when starting a new feature, refactor, bug fix, or migration; when multi-file work needs a reviewable plan; or right after a discuss-before-begin session has reached consensus. Keeps decisions, plans and the "why"

天轰穿 的更多技能

浏览全部技能

Android设备远程控制与屏幕理解引擎,基于uiautomator2+FastMCP,支持多设备连接池+心跳检测、UI层级解析(dump_hierarchy核心)、元素查找与点击、触控操作(点击/滑动/输入)、APP启停、消息收发、微信专用操作、AutoGLM视觉分析。触发: Android设备操作/微信自动化/屏幕理解/UI自动化/多设备管理

作者 天轰穿1 次安装

基于AI的个性化学习助手,支持项目教程、语言学习、写作反馈、视觉学习与学习指南生成,覆盖多学科领域。

作者 天轰穿1 次安装

Automate quality gates so no change reaches production without passing tests, lint, and build

作者 天轰穿

Test web applications in real browsers via Chrome DevTools MCP. Use when building browser apps, inspecting DOM, capturing console errors, analyzing network r...

作者 天轰穿

Design stable APIs, module boundaries, and public interfaces. Use when creating REST/GraphQL endpoints, defining inter-module type contracts, or establishing...

作者 天轰穿