← 返回 Skills 市场
700
总下载
1
收藏
10
当前安装
1
版本数
在 OpenClaw 中安装
/install technical-writing
功能描述
Activate this skill whenever a user asks to write, structure, or improve developer documentation. Covers README templates, API documentation (OpenAPI, JSDoc,...
安全使用建议
This skill appears coherent and low-risk: review the scaffold.sh script before running and run it in a safe/empty directory (it will create files and folders). Treat example commands in templates (curl, sudo, kubectl, admin.example.com, etc.) as placeholders — do not execute them without replacing hostnames/credentials with your own trusted targets. If you want extra caution, open SKILL.md and the template files to confirm no organization-specific secrets or production endpoints are embedded before using or sharing generated runbooks or ADRs.
功能分析
Type: OpenClaw Skill
Name: technical-writing
Version: 1.0.0
The technical-writing skill bundle is a comprehensive collection of templates, style guides, and best practices for developer documentation. It includes a utility script, scripts/scaffold.sh, which creates a standard documentation directory structure and populates it with boilerplate markdown and configuration files. The content is purely informational and functional, with no evidence of malicious intent, data exfiltration, or prompt-injection attacks.
能力评估
Purpose & Capability
Name/description (technical writing, READMEs, ADRs, runbooks, diagrams) align with the provided templates, style guide, and scaffolding script. There are no unexpected binaries, host credentials, or unrelated service APIs required.
Instruction Scope
SKILL.md is a guidance document for writing docs and does not instruct the agent to read arbitrary system files, exfiltrate data, or call external endpoints. Example commands and URLs (e.g., curl to api.example.com, mermaid.live) appear only as templates/samples.
Install Mechanism
No install spec is present and the single script (scripts/scaffold.sh) only creates local directories and template files. No network downloads, extracts, or third-party package installs are performed by the skill itself.
Credentials
The skill declares no required environment variables, credentials, or config paths. The content includes placeholders (e.g., admin.example.com) but nothing requires access to unrelated secrets or services.
Persistence & Privilege
always is false and the skill does not request persistent system-level privileges. The scaffold script writes files to the working directory only; it does not modify other skills or system-wide agent settings.
如何使用
- 确保已安装 OpenClaw（本地或 Docker 部署）
- 在对话框中输入安装命令：
/install technical-writing - 安装完成后，直接呼叫该 Skill 的名称或使用
/technical-writing触发 - 根据 Skill 的参数说明提供必要输入，即可获得结构化输出
版本历史
v1.0.0
Technical Writing skill initial release:
- Enables structured, high-quality developer documentation for projects and APIs.
- Includes comprehensive README templates for libraries, CLI tools, and API services.
- Covers best practices and templates for API docs (OpenAPI, JSDoc/TSDoc), ADRs, RFCs, changelogs, and runbooks.
- Provides guidance on documentation structure (Diataxis framework), audience analysis, and docs lifecycle management.
- Offers style guides, docs-as-code workflow tips, and code example conventions.
- Contains a common pitfalls reference to help avoid frequent documentation mistakes.
元数据
常见问题
technical writing 是什么？
Activate this skill whenever a user asks to write, structure, or improve developer documentation. Covers README templates, API documentation (OpenAPI, JSDoc,... 它是一个面向 Claude Code / OpenClaw 的 AI Agent Skill 插件，目前累计下载 700 次。
如何安装 technical writing？
在 OpenClaw 或 Claude Code 对话框中运行命令「/install technical-writing」即可一键安装，无需额外配置。
technical writing 是免费的吗？
是的，technical writing 完全免费，采用 MIT-0 许可证，可自由下载、安装和使用。
technical writing 支持哪些平台？
technical writing 跨平台运行，可在任意部署了 OpenClaw / Claude Code 的环境中使用（cross-platform）。
谁开发了 technical writing？
由 royhk920（@royhk920）开发并维护，当前版本 v1.0.0。
推荐 Skills