← Back to Skills Marketplace
276
Downloads
2
Stars
1
Active Installs
5
Versions
Install in OpenClaw
/install tech-doc-writer
Description
This skill should be used when the user wants to write detailed technical learning documentation, study notes, or knowledge summaries for deep learning, mach...
Usage Guidance
This skill is coherent with its goal and doesn't request credentials or installs. Before using it, decide whether you're comfortable allowing the agent to: (1) fetch content from user-supplied URLs and public documentation (network access), (2) read/write the generated markdown file and run a simple local command (grep) to validate headings, and (3) auto-continue producing subsequent Parts without pausing for your approval. Avoid supplying sensitive internal URLs or secrets as reference links, and review citations and code snippets for correctness before using them in production.
Capability Analysis
Type: OpenClaw Skill
Name: tech-doc-writer
Version: 1.3.4
The tech-doc-writer skill is designed to guide an AI agent in creating detailed technical documentation. It includes structured workflows for information gathering, knowledge point enumeration, and multi-part output for large documents. The skill uses standard shell commands like grep in SKILL.md (Step 6 and 7) specifically for internal validation of the document's header structure. There is no evidence of malicious intent, data exfiltration, or unauthorized system access; the behavior is entirely consistent with the stated purpose of technical writing.
Capability Assessment
Purpose & Capability
Name/description (technical documentation authoring) aligns with the instructions and included reference examples. The skill does not request unrelated credentials, binaries, or installs.
Instruction Scope
The SKILL.md instructs the agent to fetch user-provided URLs and authoritative external docs, produce multi-part output automatically, and run a small local validation command (grep) against the generated document. These actions are consistent with creating high-quality docs, but they require network access to external webpages and the ability to read/write the generated file and run simple shell commands.
Install Mechanism
Instruction-only skill with no install spec and no code files — nothing is written to disk by an installer and no third-party packages are pulled in.
Credentials
The skill requests no environment variables or credentials. It does recommend documenting environment variables when the doc topic is a tool/framework — this may prompt the agent to consult official docs, but the skill does not require or request access to the user's environment or secrets.
Persistence & Privilege
always is false and the skill is user-invocable. The SKILL.md's strong guidance to 'auto-advance' between parts means an agent allowed to invoke skills autonomously could generate multiple sequential outputs without repeated user confirmation; this is a behavior choice, not an elevated platform privilege.
How to Use
- Make sure OpenClaw is installed (local or Docker)
- Run the install command in chat:
/install tech-doc-writer - After installation, invoke the skill by name or use
/tech-doc-writer - Provide required inputs per the skill's parameter spec and get structured output
Version History
v1.3.4
tech-doc-writer 1.3.4
- Step 1 now explicitly requires "获取当前系统时间" when identifying outdated content.
- Step 6增加了章节编号完整性校验（需用 grep -n "^## " 检查无跳号/无缺失）。
- 质量检查清单增加了获取系统时间、过时内容与未解释缩写名词的检查。
- 文档部分流程步骤和检查流程优化，细化了文档的自检和改进环节说明。
v1.3.3
**Major update: Expanded support and stricter requirements for CLI tools and configuration in technical documentation.**
- Added mandatory structure and formatting guidelines for documenting command-line (CLI) tools, including full parameter index and grouping rules.
- Introduced requirements for a dedicated environment variables section when documenting tools/frameworks with configuration or environment variable support.
- Updated document structure section to distinguish between algorithm/framework topics and CLI/tool topics, with clear judgment criteria.
- Provided standard table templates and detailed formatting instructions for parameter, subcommand, and environment variable documentation.
- Refined descriptions, checklists, and section labels to enforce completeness and up-to-date technology coverage.
v1.3.2
- Added "技术文档写作" to supported trigger phrases in the description for broader input recognition.
- Updated version number to 1.3.2.
- Removed the redundant _meta.json file for streamlining.
- No changes to the main technical writing workflow or output format.
v1.3.1
- Added metadata file `_meta.json` to the project.
- No changes to functionality or documentation; all skill logic remains unchanged.
vv1.3.0
- Major upgrade: Introduces a comprehensive, systematic framework and checklist to eliminate omissions in technical document writing for deep learning and related fields.
- Adds detailed, mandatory step-by-step workflow: from information gathering, topic checklist, and structure standardization, to segmental output and post-check reviews.
- Enforces strict checklist-driven planning (Step 1.5) to cover all relevant technical points, with cross-verification against authoritative sources.
- Mandates key documentation modules: unified theoretical perspective, full method details (with formulas, code, pros/cons tables), comparison tables, decision guides, and inclusion of recent advances.
- Requires multi-part output for long documents, with automatic progress indication and division of tasks, and introduces a strong self-check protocol post-completion.
- Defines rigorous formatting: LaTeX math, runnable code, structure tables, and visual diagrams to ensure quality, clarity, and technical accuracy.
Metadata
Frequently Asked Questions
What is Tech Doc Writer?
This skill should be used when the user wants to write detailed technical learning documentation, study notes, or knowledge summaries for deep learning, mach... It is an AI Agent Skill for Claude Code / OpenClaw, with 276 downloads so far.
How do I install Tech Doc Writer?
Run "/install tech-doc-writer" in the OpenClaw or Claude Code chat to install it in one step — no extra setup required.
Is Tech Doc Writer free?
Yes, Tech Doc Writer is completely free, licensed under MIT-0. You can download, install and use it at no cost.
Which platforms does Tech Doc Writer support?
Tech Doc Writer is cross-platform and runs anywhere OpenClaw / Claude Code is available (cross-platform).
Who created Tech Doc Writer?
It is built and maintained by hiqishen (@hiqishen); the current version is v1.3.4.
More Skills