Publication Ready Docs Jev

撰写、精简和审查正式工程文档,用 Jev 检测冗余表达与跨章节重复。适用于发布前检查、冗余清理和质量复核。

9 stars 1 forksWriting & Content

Install

skills CLI (Claude Code, Cursor, Codex and more)
npx skills add lingengyuan/my-skills --skill publication-ready-docs-jev
Manual install
git clone --depth 1 https://github.com/lingengyuan/my-skills.git /tmp/my-skills
mkdir -p ~/.claude/skills
cp -r /tmp/my-skills/.claude/skills/publication-ready-docs-jev ~/.claude/skills/publication-ready-docs-jev

Personal skills live in ~/.claude/skills. Use .claude/skills in a project folder to share a skill with your team.

From the SKILL.md

# Publication Ready Docs with Jev

工程文档让读者能独立理解、实施、运行和验证。先查证事实,再确定本次必要内容,先删后改,用 Jev 预审冗余,最后人工核对语义。

## 内容范围

- **详细设计 / 技术方案**:目标、规则、改动对象、职责、接口契约、状态流转、关键代码和配置。
- **运行手册**:前置条件、操作步骤、回滚和恢复。
- **测试与审计**:验证场景、预期结果、实测结果;审计、复盘和 ADR 保留必要权衡。

按文档类型和任务取舍章节,按真实主题合并零碎小节,标题层级统一。部署、测试或审查证据按需写入。

## 工作流程

1. **查证来源**:核对源码、规范、表结构、配置与既有详设。简述复用机制与本次差异。需要定位时标注模块、文件、类、函数或配置项。
2. **确定内容**:列出读者需要的事实、规则、改动对象、关键代码和配置。先用可用工具查源码、规范、配置和已有查询结果;需要用户协助时,在会话给出具体查询项或 SQL,取得结果后写入正文。影响方案成立的外部业务条件保留,并在会话确认。
3. **区分状态**:分别写清现有行为、拟设计方案和已实施结果。
4. **先删再润色**:删除后读者仍能完成任务的内容直接删去。保留内容简写为规则和条件。清理过程记录、自我评价、空泛承诺、重复定义、模板空章节和无新增信息的提醒。
5. **去重**:一个事实只定义一次。字段位数、枚举和约束写在表格时,正文只写表格未覆盖的类型和解析规则。同步检查正文、表格单元格、括注和代码注释。仅清理文字和注释时,代码执行语句保持原样;方案调整时,同步修改代码和契约。
6. **Jev 预审**:草稿完成后运行自动审查,报告作为线索决定删、改、留。仅审查时交付报告;获得授权后,基于最新版本局部修改正文、表格、代码和前提条件,改后回读。
7. **核对并同步**:核对语义、边界、职责、数值和未决条件,沿用项目约定的模板,保留既有图表资源。交付前按参考复核。

## Jev 自动审查

```bash
python3 scripts/jev_doc_review.py <input.md> --doc-type 详细设计
```

脚本扫描正文、表格单元和已知语言的代码注释;代码执行语句只作上下文。输出 `<input>.review.md` 和 `<input>.review.json`,默认不改原文。运行需要 `TYPESAFE_API_KEY`、Python 3.10+ 和 `typesafe_sdk`。未闭合代码块和无法识别的语言记入 `skipped`。

报告是线索,按信息价值和项目必要性决定删、改、留:

- 建议删除、合并或改写:结合上下文核对,同一事实保留权威定义。
- 表格单元:按表头和同行字段理解。完整字段表定义(含各单元格)优先于正文和注释复述;同一行不同列不是重复定义。
- 代码注释:按相邻代码理解。复述正文或表格的注释删除,独立说明保留。
- 调用失败:记录失败,继续人工审查,并说明自动审查未完成。

## 写作规则

- 短句、主动语态、一句一个要点。术语首次出现时定义,全篇用同一叫法。条件写在动作前。命令、路径、表名和字段名用代码格式。
- 规则写清主体、条件、动作和结果。必要边界用正面具体指令表达,例如“只更新 `A` 表的 `B` 字段”。
- 字段禁填、长度、枚举含义、事务边界、失败后果、兼容性和数据写入范围保留一次。
Read the full skill on GitHub

Details

Skill name
publication-ready-docs-jev
Path
.claude/skills/publication-ready-docs-jev/SKILL.md
License
MIT
Repo updated
14 November 2026

FAQ

What does the Publication Ready Docs Jev skill do?

撰写、精简和审查正式工程文档,用 Jev 检测冗余表达与跨章节重复。适用于发布前检查、冗余清理和质量复核。

How do I install the Publication Ready Docs Jev skill?

skills CLI (Claude Code, Cursor, Codex and more): npx skills add lingengyuan/my-skills --skill publication-ready-docs-jev. Skills go in ~/.claude/skills (personal) or .claude/skills (project), and Claude loads them automatically when a task matches the description.

Is Publication Ready Docs Jev popular?

It lives in lingengyuan/my-skills, which has 9 GitHub stars and 1 forks.

Related skills

Brief Output

9

lingengyuan/my-skills

精简回答、技术说明与工程文档,删除冗余信息与 AI 味表达,只保留完成任务所需的必要事实与技术决策。适用于精简输出、压缩改写、去除 AI 腔调以及全文一致性修订。

AI, LLMs & Agents

Google Go Style

9

lingengyuan/my-skills

按 Google Go Style 编写、重构或审查 Go 代码。用于命名、注释、接口、错误处理、并发、包组织与可维护性决策。

Software Development

Insight Collector

9

lingengyuan/my-skills

Analyze URLs, source code, images, technical documents, or notes, and archive reusable insights, code snippets, and architecture patterns into a knowledge base. Use when collecting knowledge, archiving technical articles, saving reusable code, or recording insights (收录, 记录一下).

Software Development

Readme Maintainer

9

lingengyuan/my-skills

Maintain, update, and rewrite concise, publication-ready repository README files grounded in codebase facts. Use when updating README.md, refreshing installation and usage guides, verifying CLI commands, or aligning bilingual documentation.

Writing & Content

Publication Ready Docs

9

lingengyuan/my-skills

撰写和修订正式工程技术文档(技术方案、详细设计、实施计划、README、API 文档、运行手册)。先查证源码与既有设计,删除冗余和过程性内容,保留必要的规则、改动对象、关键代码和配置。

Writing & Content

Tech Article

9

lingengyuan/my-skills

Research, draft, revise, verify, and illustrate authentic Chinese technical articles for WeChat Official Accounts or developer blogs. Use when writing technical articles, turning repositories or experiments into articles, removing AI prose patterns, or planning article illustrations.

Writing & Content

Browse the most popular Claude skills, all writing & content skills, or write your own with the skills generator.