Python编码规范
Python代码编写规范指南
文档协作(doc-coauthoring)引导用户通过结构化工作流共创文档(技术规范、提案、决策文档等)。帮助高效传递上下文、迭代优化内容、验证文档对读者的有效性。
安装 Skill:
通过 Claw Hub 安装:
clawhub install doc-coauthoring
触发条件:用户提及写文档、起草提案、创建规范、PRD、RFC、设计文档等。Claude会提供结构化工作流选项,用户可选择使用工作流或自由形式。
阶段1-上下文收集:询问文档类型、目标受众、期望影响、模板格式、约束条件。鼓励用户以任意形式倾泻所有上下文(项目背景、讨论、技术架构、时间线、利益相关者顾虑等)。如有模板或共享文档链接,Claude会读取。如有图片缺少alt-text,会建议生成以提高可访问性。
澄清问题:用户完成初步倾泻后,Claude会提出5-10个澄清问题填补知识空白,确保理解完整。
阶段2-优化结构:逐节迭代构建文档,每节通过头脑风暴和编辑优化。保持简洁、可扫描、清晰。
阶段3-读者测试:用无上下文的Claude实例测试文档,模拟首次阅读的读者,识别盲点、缺失背景、不明确术语。记录问题并迭代修复。
外部集成:如有Slack、Teams、Google Drive等集成,可直接拉取上下文。如未启用,建议用户在Claude设置中启用连接器。
| 项目 | 内容 |
|---|---|
| 输入 | 文档类型、受众、项目上下文、现有文档、约束 |
| 输出 | 结构化文档、澄清问题、读者测试反馈、改进建议 |
| 适用人群 | 编写技术文档的团队、产品经理、技术领导 |
| 不包含 | 自动生成、格式模板库、多语言翻译 |
见下方输入与输出表格。
原始链接:https://github.com/openclaw/skills/tree/main/skills/seanphan/doc-coauthoring/SKILL.md
来源类型:GitHub