← Back to Skills Marketplace
700
Downloads
1
Stars
10
Active Installs
1
Versions
Install in OpenClaw
/install technical-writing
Description
Activate this skill whenever a user asks to write, structure, or improve developer documentation. Covers README templates, API documentation (OpenAPI, JSDoc,...
Usage Guidance
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.
Capability Analysis
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.
Capability Assessment
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.
How to Use
- Make sure OpenClaw is installed (local or Docker)
- Run the install command in chat:
/install technical-writing - After installation, invoke the skill by name or use
/technical-writing - Provide required inputs per the skill's parameter spec and get structured output
Version History
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.
Metadata
Frequently Asked Questions
What is technical writing?
Activate this skill whenever a user asks to write, structure, or improve developer documentation. Covers README templates, API documentation (OpenAPI, JSDoc,... It is an AI Agent Skill for Claude Code / OpenClaw, with 700 downloads so far.
How do I install technical writing?
Run "/install technical-writing" in the OpenClaw or Claude Code chat to install it in one step — no extra setup required.
Is technical writing free?
Yes, technical writing is completely free, licensed under MIT-0. You can download, install and use it at no cost.
Which platforms does technical writing support?
technical writing is cross-platform and runs anywhere OpenClaw / Claude Code is available (cross-platform).
Who created technical writing?
It is built and maintained by royhk920 (@royhk920); the current version is v1.0.0.
More Skills