技术写作助手（tech-docs）
自动生成 README.md 模板并提供 Markdown 文档质量检查与评分。
核心差异化（对标头部「技术写作」工具）
- 竞品弱点：多数写作工具要么只生成（无质量反馈）、要么只检查（无生成能力）；需要两个工具来回切换。
- 我们：生成 + 检查一体化：
1. README 一键生成——输入项目名称 + 描述，输出完整的 README.md（含安装/快速开始/API/测试/贡献/许可证标准章节）。
2. 文档质量检查——6 条规则扫描：缺标题/行过长/空标题/缺语言标识/缺标准章节，自动评分（百分制）。
3. 问题定位——每个问题标注 severity 和改进建议。
4. JSON 输出——评分和结果可被 CI/CD 流水线消费。 - 本地安全：文档不离开本机，适合企业内网项目文档。
快速开始
# 生成 README（演示模式）
python3 scripts/tech-docs.py --readme --demo
# 文档质量检查（演示模式）
python3 scripts/tech-docs.py --check --demo
# 生成 README（指定名称）
python3 scripts/tech-docs.py --readme --name "我的项目"
# JSON 输出（供 CI/Agent 调用）
python3 scripts/tech-docs.py --check --demo --json
何时使用本技能
用户说以下任一即触发：
- 「写 README / 生成 README / 帮我写文档」
- 「文档质量检查 / 我的文档评分多少」
- 「技术文档生成 / API 文档模板」
工作流（Agent 使用建议）
- 生成模式：
tech-docs.py --readme --name "<项目名>"生成完整 README 模板。 - 检查模式：读取用户文档内容 →
tech-docs.py --check获取评分和问题。 - 输出建议：按 severity 排序问题，优先报告 high/medium 级。
- 交付：生成好的 README 或检查报告交给用户。
已知边界
- README 生成：基于模板填充，不包含项目实际代码结构和依赖信息。
- 文档检查：6 条基础规则（标题/行长度/空标题/代码块语言/章节完整性），非完整 Markdown 规范检查。
- 评分：百分制，每问题扣 15 分，最低 0 分，为近似值。
- 无 LLM 参与：纯模板 + 规则匹配，不依赖大语言模型。
> AI生成
