← 返回 Skills 市场
1kalin

Technical Documentation Engine

作者 1kalin · GitHub ↗ · v1.1.0
cross-platform ✓ 安全检测通过
961
总下载
1
收藏
2
当前安装
2
版本数
在 OpenClaw 中安装
/install afrexai-technical-docs
功能描述
Complete technical documentation system — from planning through maintenance. Covers READMEs, API docs, guides, architecture docs, runbooks, and developer por...
使用说明 (SKILL.md)

k97c49f84j6eafk6sxjfc9t9sd819e1e

安全使用建议
This is an instruction-only documentation template and audit skill — low-risk compared with code-based skills. Before installing: (1) Understand it will ask the agent to inspect your repository to produce audits and docs (only grant repository access if you trust the agent). (2) The templates include example env variables (API_KEY) for docs; do not paste real secrets into prompts or skill configuration. (3) The README links to external paid 'context packs' and webpages — those are marketing/optional. If you need stronger guarantees, review any outputs locally before committing generated docs to repositories or pipelines.
功能分析
Type: OpenClaw Skill Name: afrexai-technical-docs Version: 1.1.0 The OpenClaw AgentSkills skill bundle 'afrexai-technical-docs' is benign. The `SKILL.md` file provides comprehensive instructions and templates for an AI agent to generate, audit, and maintain technical documentation. All embedded code blocks are examples for the *generated documentation* (e.g., `curl` commands, `bash` installation steps) and not direct commands for the *agent* to execute. The 'Natural Language Commands' section in `SKILL.md` and `README.md` lists user-facing commands that are fully aligned with the stated purpose of documentation management. There are no instructions for data exfiltration, unauthorized execution, persistence, or prompt injection against the agent to perform harmful actions. External links in `README.md` point to legitimate domains (github.io, clawhub.com) for marketing and other skills.
能力评估
Purpose & Capability
The name and description (technical documentation engine) match the SKILL.md and README contents: audit checklists, templates, scoring, and maintenance guidance. There are no unrelated environment variables, binaries, or install steps requested that would be disproportionate to producing docs.
Instruction Scope
The runtime instructions focus on auditing and producing documentation and templates. They assume access to the project/codebase for an audit (expected for this purpose) but do not instruct the agent to read unrelated system files, secrets, or external endpoints for data exfiltration. Templates include placeholder examples (e.g., an API_KEY export) which are examples for docs, not required credentials for the skill itself.
Install Mechanism
This is an instruction-only skill with no install spec and no code files, so nothing is written to disk or downloaded during install. That is the lowest-risk model and is proportionate for a templates-and-guidance skill.
Credentials
The skill declares no required environment variables, credentials, or config paths. The README/templates show example env snippets (API_KEY) for users to include in their projects, but the skill itself doesn't request or require secrets.
Persistence & Privilege
always:false (normal). The skill can be invoked autonomously by the agent (platform default). This is expected for skills, and there is no indication the skill requests permanent system-level presence or modifies other skills/configuration.
如何使用
  1. 确保已安装 OpenClaw(本地或 Docker 部署)
  2. 在对话框中输入安装命令:/install afrexai-technical-docs
  3. 安装完成后,直接呼叫该 Skill 的名称或使用 /afrexai-technical-docs 触发
  4. 根据 Skill 的参数说明提供必要输入,即可获得结构化输出
版本历史
v1.1.0
10X rebuild: 29KB SKILL.md with 7 templates, 100-point rubric, docs-as-code pipeline, ADR format, maintenance system
v1.0.0
Technical Documentation Engine 1.0.0 — initial release - Provides a complete, structured system for technical documentation covering architecture decisions, API references, runbooks, changelogs, and docs-as-code workflows. - Includes actionable frameworks: documentation audit scorecard, quick wins checklist, and best-practice templates for README, ADR, and API docs. - Emphasizes real examples, maintainability, onboarding speed, and reducing support overhead. - Clear rules and checklists ensure documentation remains useful, up-to-date, and trusted by developers.
元数据
Slug afrexai-technical-docs
版本 1.1.0
许可证
累计安装 2
当前安装数 2
历史版本数 2
常见问题

Technical Documentation Engine 是什么?

Complete technical documentation system — from planning through maintenance. Covers READMEs, API docs, guides, architecture docs, runbooks, and developer por... 它是一个面向 Claude Code / OpenClaw 的 AI Agent Skill 插件,目前累计下载 961 次。

如何安装 Technical Documentation Engine?

在 OpenClaw 或 Claude Code 对话框中运行命令「/install afrexai-technical-docs」即可一键安装,无需额外配置。

Technical Documentation Engine 是免费的吗?

是的,Technical Documentation Engine 完全免费(开源免费),可自由下载、安装和使用。

Technical Documentation Engine 支持哪些平台?

Technical Documentation Engine 跨平台运行,可在任意部署了 OpenClaw / Claude Code 的环境中使用(cross-platform)。

谁开发了 Technical Documentation Engine?

由 1kalin(@1kalin)开发并维护,当前版本 v1.1.0。

💬 留言讨论