tech-doc-reviewer

tech-doc-reviewer is a skill for Claude Code, Codex from open-vela/.claude. It costs 112 tokens per session (985 once invoked), scanned A, original, Apache-2.0.

A review workflow for Markdown technical documentation, with a report and a complete improved version of the document. Markdown is a plain-text format commonly used for documentation.

In plain words
What is it for?
Use it to review files under docs/, check headings and code examples, expand abbreviations, preserve links and images, flag sensitive information, and produce a replacement Markdown document in Chinese.
Why use it?
It catches structural, terminology, security, link, language, and technical problems before the document is published, without writing changes until the user confirms.

Skill for Claude CodeCodex

Written for no agent in particular: nothing here depends on one.

Good fit Use it to review files under docs/, check headings and code examples, expand abbreviations, preserve links and images, flag sensitive information, and produce a replacement Markdown document in Chinese.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/open-vela/.claude/tech-doc-reviewer
Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

Any agent
npx skills add open-vela/.claude --skill tech-doc-reviewer
Clone the repo
git clone --depth 1 https://github.com/open-vela/.claude

Made for: Claude Code, Codex.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for tech-doc-reviewer

README.md
[![agentmods](https://agentmods.dev/badge/skills/open-vela/.claude/tech-doc-reviewer/github.svg)](https://agentmods.dev/skills/open-vela/.claude/tech-doc-reviewer)
Your own site
<a href="https://agentmods.dev/skills/open-vela/.claude/tech-doc-reviewer"><img src="https://agentmods.dev/badge/skills/open-vela/.claude/tech-doc-reviewer/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for tech-doc-reviewer

Your own site · 80×15
<a href="https://agentmods.dev/skills/open-vela/.claude/tech-doc-reviewer"><img src="https://agentmods.dev/badge/skills/open-vela/.claude/tech-doc-reviewer.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 112 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 985 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.00112 $0.00985
Opus 5 $0.00056 $0.00492
Sonnet 5 $0.00022 $0.00197
Haiku 4.5 $0.00011 $0.00098

Measured 11d ago against content hash b168210e86f1, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-11, from the pricing page.

Security

Grade A, and why

tech-doc-reviewer scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 11d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

skills/tech-doc-reviewer/SKILL.md · 102 lines

What it actually says

技术文档审校 Skill

⚡ TL;DR

提供 docs/ 下的 Markdown 文件路径 → 读取文件 → 按 8 个维度审校 → 输出审校报告 + 优化后完整文档。

角色定义

技术文档高级工程师 + 嵌入式系统专家:

  • 遵循《微软技术文档写作指南》简洁、清晰、以用户为中心的原则
  • 运用金字塔写作原理(结论先行、层层递进)
  • 精通 NuttX RTOS、POSIX 兼容特性、模块化架构
  • 熟悉 openvela 技术栈(LVGL、uORB、Binder、QuickJS/WAMR、OP-TEE 等)

审校维度

1. 结构化优化

  • 金字塔原理重组:结论/目的先行,再展开细节
  • 标题层级合理(h1 → h2 → h3),不跳级
  • 段落间逻辑连贯,使用过渡句衔接
  • 长段落拆分,每段聚焦一个要点
  • 适当使用列表、表格提升可读性

2. 术语与缩略语规范

  • 首次出现给出全称:实时操作系统(RTOS)
  • 后续直接使用缩写
  • 全文术语一致性
  • NuttX、POSIX、LVGL、uORB、Binder 等保持原始大小写

3. openvela 品牌规范

  • openvela 始终全小写,不用反引号包裹
  • 句首也保持小写

4. 安全合规检查

排查敏感信息(IP 地址、端口、密码、Token、手机号、内部域名),发现后用占位符替换并标记「⚠️ 安全合规」。

5. 语态与表达

  • 主动语态,避免被动
  • 祈使句描述操作步骤
  • 语言简洁直接
  • 中英文之间添加空格

6. 图片与链接处理

  • 保留所有图片引用和超链接,不修改路径/URL
  • 缺少 alt 文本的图片添加描述性 alt

7. 技术准确性

  • 审查技术描述是否准确
  • 检查 API 名称、CONFIG_xxx、命令行示例
  • 检查代码示例语法正确性
  • 不确定的标记「⚠️ 待确认」

8. 优化建议标记

对可能冗余、可合并、建议调整顺序、可补充的内容,标记「💡 优化建议」并说明理由,由用户决策。

工作流程

  1. 读取用户指定的文件
  2. 如需上下文,搜索相关文件或查看目录结构
  3. 进行全面审校分析
  4. 输出审校报告(表格形式)
  5. 输出优化后的完整 Markdown 文档
  6. 用户确认后写入文件

输出格式

第一部分:审校报告

类别 位置 问题描述 处理方式
术语规范 第 X 行 ... 已修正 / 💡 优化建议 / ⚠️ 待确认

第二部分:优化后的完整文档

可直接替换原文件的完整 Markdown 内容。

约束

  • 所有输出使用中文(技术术语和专有名词除外)
  • 不改变文档核心技术含义
  • 不删除任何内容,只标记优化建议
  • 保持 Markdown 格式规范
  • 代码块保持原样,仅修正明显语法错误
  • Markdown 缩进统一使用 4 个空格,不使用 Tab
Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 11d ago First seen · 102 lines · 112 tokens per session scan A b168210e86f1

Subscribe to this mod's changes

tech-doc-reviewer is a skill published in the GitHub repository open-vela/.claude (5 stars, last pushed yesterday), licensed Apache-2.0. It adds 112 tokens to every session and 985 once invoked, about $0.0006 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.

Related

Other skills, from other repositories

systematic-debugging

Use when encountering any bug, test failure, or unexpected behavior, before proposing fixes.

obra/superpowers · 21 tokens

local-ai-agents

Build local-first AI agents that run entirely on a developer workstation with Microsoft Foundry Local and Qwen function-calling models. Covers Small Language Models (SLMs), the OpenAI-compatible local endpoint, sandboxed local tools, local RAG with Chroma, local MCP servers, hybrid cloud/local routing, and the…

microsoft/ai-agents-for-beginners · 200 tokens

next-cache-components-adoption

Turn on Cache Components in a Next.js app and resolve the blocking routes it surfaces. Use when the user wants to enable, adopt, or migrate to Cache Components, flip the cacheComponents flag, work through a flood of blocking-prerender / instant validation errors, run the cache-components-instant-false codemod, or…

vercel/next.js · 95 tokens

insight-error-page

Write or audit an insight-kind error page for the Next.js dev overlay. Use when creating a new errors/ .mdx page, auditing an existing one, or checking that a page matches the framework fix cards. Covers page structure, title alignment, FixCard cards with Copy prompt button, code snippets, terminology verification…

vercel/next.js · 83 tokens

next-cache-components-optimizer

Drive a Next.js route to instant navigation by setting up an agentic loop, under Cache Components / PPR, on initial load (hard navigation) and client-side navigation (soft navigation). Encode the goal as a failing @next/playwright instant() e2e and work it to green, one verified route at a time; the shipped test then…

vercel/next.js · 170 tokens

next-partial-prefetching-adoption

Turn on Partial Prefetching in a Next.js app and work through the insights it surfaces. Use when the user wants to enable or adopt Partial Prefetching, flip the partialPrefetching flag, opt routes in with export const prefetch = 'partial', audit Link prefetch={true} behavior, preserve existing prefetched UI with…

vercel/next.js · 103 tokens