效率
返回Skills 列表
文档清理与规范检查 Skill
给 Markdown 文档做一次规范体检:标题层级跳跃、中英文空格、死链、TODO 残留、超长行、表格错位,逐项指出并给改法。
📁 文档清理与规范检查 Skill /
SKILL.md0.9 KB
scripts
doc_lint.py4 KB
所有文件均为纯文本展示,仅提供查看与打包下载,不在服务器上执行。
SKILL.md
---
name: docs-lint
description: 给 Markdown 文档做一次规范体检:标题层级跳跃、中英文空格、死链、TODO 残留、超长行、表格错位,逐项指出并给改法。
---
# 文档清理与规范检查 Skill
## 触发条件
当文档要对外发布、要交给同事、或文档越写越乱需要统一格式时触发。
## 执行步骤
1. 运行 python scripts/doc_lint.py docs/ -o lint.md。
2. 看标题层级是否跳跃(h2 直接跳 h4),逐条改。
3. 处理中英文之间缺空格的问题,脚本给出位置清单。
4. 检查链接:站内相对链接是否存在,外部链接标记待人工确认。
5. 清掉 TODO、占位文案与重复空行,最后统一文末格式。
## 依赖
Python 3 标准库(re/argparse/pathlib),不联网验证外链。
## 输出
一份 lint.md:问题清单(文件/行号/类型/建议)、修改优先级排序。
纯文本预览
全站累计复制 0 次
使用说明
文档对外发布前跑一遍,按优先级修完再交出去。
每个 IP 仅可点赞一次 · 点赞后不可取消

暂无评论,来发表第一条评论吧!