staff-document

.staffreview/docs/ 课程：从 GitHub PR 审查评论或 Staff Review 线程中编写文档 本课程将指导你如何从 GitHub 拉取请求（PR）审查评论或 Staff Review 讨论线程中提取有价值的信息，并将其转化为清晰、结构化的 `.staffreview/docs/` 文档。 目标： - 识别 PR 审查中具有教学意义或流程改进价值的评论 - 将零散的反馈整理为可复用的知识条目 - 遵循团队文档规范，确保内容准确、简洁、易于理解 步骤： 1. 选择一条具有代表性的 PR 审查评论或 Staff Review 线程（例如：关于代码风格、架构决策、测试覆盖或安全实践的深入讨论）。 2. 提取核心问题、建议和改进点，避免包含个人情绪或临时性上下文。 3. 使用标准模板编写文档条目，包括： - 标题：简明概括主题（如“避免在循环中执行数据库查询”） - 背景：简要说明该问题的常见场景 - 建议做法：提供最佳实践或推荐解决方案 - 示例（可选）：附上正确与错误代码片段对比 - 相关链接：指向相关规范、工具或已有文档 4. 将文档保存至 `.staffreview/docs/` 目录下，文件名采用小写加连字符格式（如 `avoid-n-plus-one-queries.md`）。 5. 提交 PR 并邀请团队成员审阅，确保内容准确且对他人有帮助。 提示： - 优先记录反复出现的问题或引发激烈讨论的主题 - 保持中立语气，聚焦于“做什么”和“为什么”，而非“谁做错了” - 定期回顾和更新文档，确保其与当前实践保持一致 通过此流程，团队可将审查中的隐性知识显性化，提升整体代码质量和协作效率。

存档时间线

版本索引永久保留；内容副本只保留最新 1 份，更早版本仅留索引与哈希（存档时间线的证据链不会因此断裂）。

下载存档内容副本