log-doc-issues
Compare original and translation side by side
🇺🇸
Original
English🇨🇳
Translation
Chinese/log-doc-issues
/log-doc-issues
Run documentation audit and create GitHub issues for all findings.
运行文档审计并为所有检测结果创建GitHub Issue。
What This Does
功能说明
- Invoke to audit documentation
/check-docs - 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 to fix issues.
/fix-docs- 调用/check-docs对文档进行审计
- 按优先级（P0-P3）解析检测结果
- 检查现有Issue以避免重复创建
- 为每个检测结果创建GitHub Issue
这是一个Issue创建工具，它仅创建工作项，不修复问题。请使用/fix-docs来修复问题。
Process
流程
1. Run Primitive
1. 运行基础工具
Invoke skill to get structured findings.
/check-docs调用/check-docs工具获取结构化的检测结果。
2. Check Existing Issues
2. 检查现有Issue
bash
gh issue list --state open --label "domain/docs" --limit 50bash
gh issue list --state open --label "domain/docs" --limit 503. 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
Problem
README.md exists but lacks Installation section. New developers cannot set up the project.
README.md exists but lacks Installation section. New developers cannot set up the project.
Impact
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
Location
README.mdREADME.mdSuggested Fix
Suggested Fix
Run or add manually:
/fix-docs- Prerequisites (Node version, etc.)
- Package manager commands
- Environment setup steps
Created by
EOF
)"
--label "priority/p1,domain/docs,type/chore"
/log-doc-issues--label "priority/p1,domain/docs,type/chore"
undefinedRun or add manually:
/fix-docs- Prerequisites (Node version, etc.)
- Package manager commands
- Environment setup steps
Created by
EOF
)"
--label "priority/p1,domain/docs,type/chore"
/log-doc-issues--label "priority/p1,domain/docs,type/chore"
undefined4. Issue Format
4. Issue格式
Title:
[P{0-3}] Documentation gap descriptionLabels:
- |
priority/p0|priority/p1|priority/p2priority/p3 domain/docstype/chore
Body:
markdown
undefined标题：
[P{0-3}] 文档缺失/问题描述标签：
- |
priority/p0|priority/p1|priority/p2priority/p3 domain/docstype/chore
正文：
markdown
undefinedProblem
问题描述
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-issuesundefined可运行的工具或手动操作步骤
由/log-doc-issues创建
undefinedPriority 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/docsRelated
相关工具
- - The primitive (audit only)
/check-docs - - Fix documentation gaps
/fix-docs - - Full documentation workflow
/documentation - - Full backlog grooming
/groom
- - 基础工具（仅审计）
/check-docs - - 修复文档问题
/fix-docs - - 完整文档工作流
/documentation - - 完整待办事项梳理
/groom