log-doc-issues

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

/log-doc-issues

Run documentation audit and create GitHub issues for all findings.

运行文档审计并为所有检测结果创建GitHub Issue。

What This Does

功能说明

Invoke
```
/check-docs
```
to audit documentation
Parse findings by priority (P0-P3)
Check existing issues to avoid duplicates
Create GitHub issues for each finding

This is an issue-creator. It creates work items, not fixes. Use

/fix-docs

to fix issues.

调用/check-docs对文档进行审计
按优先级（P0-P3）解析检测结果
检查现有Issue以避免重复创建
为每个检测结果创建GitHub Issue

这是一个Issue创建工具，它仅创建工作项，不修复问题。请使用/fix-docs来修复问题。

Process

流程

1. Run Primitive

1. 运行基础工具

Invoke

/check-docs

skill to get structured findings.

调用/check-docs工具获取结构化的检测结果。

2. Check Existing Issues

2. 检查现有Issue

bash

gh issue list --state open --label "domain/docs" --limit 50

bash

gh issue list --state open --label "domain/docs" --limit 50

3. Create Issues

3. 创建Issue

For each finding:

bash

gh issue create \
  --title "[P1] README missing Installation section" \
  --body "$(cat <<'EOF'

针对每个检测结果：

bash

gh issue create \
  --title "[P1] README missing Installation section" \
  --body "$(cat <<'EOF'

Problem

README.md exists but lacks Installation section. New developers cannot set up the project.

Impact

Contributor onboarding blocked
Time wasted figuring out setup
Potential contributors give up

Contributor onboarding blocked
Time wasted figuring out setup
Potential contributors give up

Location

README.md

README.md

Suggested Fix

Run

/fix-docs

or add manually:

Prerequisites (Node version, etc.)
Package manager commands
Environment setup steps

Created by

/log-doc-issues

EOF )"
--label "priority/p1,domain/docs,type/chore"

undefined

Run

/fix-docs

or add manually:

Prerequisites (Node version, etc.)
Package manager commands
Environment setup steps

Created by

/log-doc-issues

EOF )"
--label "priority/p1,domain/docs,type/chore"

undefined

4. Issue Format

4. Issue格式

Title:

[P{0-3}] Documentation gap description

Labels:

priority/p0

priority/p1

priority/p2

priority/p3

```
domain/docs
```
```
type/chore
```

Body:

markdown

undefined

标题：

[P{0-3}] 文档缺失/问题描述

标签：

priority/p0

priority/p1

priority/p2

priority/p3

```
domain/docs
```
```
type/chore
```

正文：

markdown

undefined

Problem

问题描述

What documentation is missing or broken

文档缺失或存在的问题

Impact

影响范围

Who is affected (new devs, users, contributors)

受影响的人群（新开发者、用户、贡献者等）

Location

位置

File path or expected file location

文件路径或预期文件位置

Suggested Fix

修复建议

Skill to run or manual action

Created by

/log-doc-issues

undefined

可运行的工具或手动操作步骤

由/log-doc-issues创建

undefined

Priority Mapping

优先级映射

Gap	Priority
Missing README.md	P0
Missing .env.example (with env vars used)	P0
README missing key sections	P1
Undocumented env vars	P1
Missing architecture docs	P1
Stale documentation (90+ days)	P2
Missing CONTRIBUTING.md	P2
Missing ADR directory	P2
Broken links	P2
Polish improvements	P3

问题类型	优先级
缺少README.md	P0
缺少.env.example（包含使用的环境变量）	P0
README缺少关键章节	P1
环境变量未文档化	P1
缺少架构文档	P1
文档过时（超过90天）	P2
缺少CONTRIBUTING.md	P2
缺少ADR目录	P2
链接失效	P2
优化改进	P3

Output

输出示例

After running:

Documentation Issues Created:
- P0: 0
- P1: 3 (README sections, env vars)
- P2: 2 (stale docs, ADRs)
- P3: 1 (link checking)

Total: 6 issues created
View: gh issue list --label domain/docs

运行后输出：

Documentation Issues Created:
- P0: 0
- P1: 3 (README sections, env vars)
- P2: 2 (stale docs, ADRs)
- P3: 1 (link checking)

Total: 6 issues created
View: gh issue list --label domain/docs

log-doc-issues

Original

Translation

/log-doc-issues

/log-doc-issues

What This Does

功能说明

Process

流程

1. Run Primitive

1. 运行基础工具

2. Check Existing Issues

2. 检查现有Issue

3. Create Issues

3. 创建Issue

Problem

Problem

Impact

Impact

Location

Location

Suggested Fix

Suggested Fix

4. Issue Format

4. Issue格式

Problem

问题描述

Impact

影响范围

Location

位置

Suggested Fix

修复建议

Priority Mapping

优先级映射

Output

输出示例

Related

相关工具