techcamp

日报写作规范

概述

日报是关于”进展”的汇报，描述在整体目标下，个人当天的实际进展或成果。这个进展的汇报有利于团队协作和项目风险的及早识别。

基本要求

1. 结构清晰

• 今日完成：具体做了什么，有什么成果
• 明日计划：明确的目标和任务

注：原则上不需要在日报中描述”遇到问题或疑惑”，因为真正的问题应该及时提出并解决。如果是自己解决不了的，阻塞性问题，应该在工作过程中主动寻求帮助。

2. 内容要求：结果导向、产物导向

日报的核心是展示具体成果和可验证的产出。如果成果可以用几句话说明清楚，就直接在日报中体现；如果无法简单描述，则需要提供相关链接来指向具体产出物。

比如：

• 功能开发：应该提供 PR 链接，展示代码成果
• 设计工作：应该提供文档/原型链接，展示设计成果
• 会议讨论：应该明确结论或决策，展示讨论成果
• 学习研究：应该说明具体收获和结论，展示学习成果

3. 语言要求

言简意赅，用最少的字数说明清楚进展，避免模糊不清、表达冗余。

一些原则：

• 具体化描述：如”完成用户登录功能开发，支持手机号+验证码登录”而非”开发登录功能”
• 概念区分：注意用词的准确性。”完成”表示工作已结束且有成果，”开发”表示正在进行的工作。进行中的工作要给出进度表示，如”用户管理模块开发进度 60%，预计明天完成”

优秀示例

今日完成：
1. 完成用户登录API开发，支持手机号+验证码登录，提升用户体验: https://github.com/xxx/pull/123
2. 完成用户管理数据库表结构设计: https://github.com/xxx/issues/456
3. 参加架构讨论会，确定采用微服务架构，技术栈选型完成，预计可支持10万用户并发
4. 解决数据库连接超时问题 - 通过调整连接池配置，将响应时间从5秒优化到200ms： https://github.com/xxx/pull/457

明日计划：
1. 开发用户注册功能，预期完成注册API和邮箱验证功能

写在最后

高质量的日报，不仅是工作成果的展示，更是专业素养的体现和成长轨迹的记录。通过规范的日报写作，我们可以培养自身严谨的工作态度和清晰的表达能力，而这也是优秀工程师的必备素养。

This site is open source. Improve this page.