今天最郁闷的应该是
文档又被新的PM批评了好多次
好歹也写了一年的文档了，本以为可以过关进行评审了，这下又要大改了
如果以前的PM的话，则不会要求这么多
也许是女生的天性，新PM竟然对文档如此较真
更难得的是，她对字里行间的逻辑结构也看的一清二楚
一份三页的文档，她从格式，术语，逻辑表达、图示、字体、颜色等等，可谓是无所不包
差点超出我的承受极限
静下来想
有个道理很简单：
初次作成的文档决定了评审的质量
如果，第一次是60，别人也只能帮你提高到80分
如果第一次是80分，别人会帮你提高到90分
如果你是99分，也许自己总是提高不到100分，别人很容易就能帮你找到那差的一分
只是，做起来就没那么轻松了，精益求精的事枯燥，同时也要花不少时间
对我这中大大咧咧的人，想写出好文档的确有点难
分享到：
相关推荐
在软件开发中，每个文档都应有唯一的编号，便于追踪其版本历史，而版本号则标识了文档的更新状态，如“V1.0”代表初版，“V1.1”表示对初版进行了修订。 《系统规约说明书》是软件设计的起点，其中包含了软件的主要...
"展讯测试用例-初版"这个标题暗示了这是一份针对名为"展讯"的项目或产品的初期测试用例文档。测试用例是系统或应用程序进行测试的详细步骤集合，它们定义了测试人员如何验证特定功能是否按预期工作。这份初版可能...
- 开发人员提交初版文档到评审组，配置人员存入VSS评审库。 - 进行电子或会议评审，主审员主导，评审意见以批注形式记录。 - 开发人员根据评审意见更新文档，反复此过程，直至满足评审要求。 - 主审员确认版本...
锐宏质量办法是一套针对锐宏电子科技有限公司质量管理的系统性文件，旨在规范公司的质量活动，提高产品质量，增强市场竞争力，并符合ISO9001:2008和ISO/TS16949:2009的质量管理体系标准。这套办法通过一系列文档化的...
在政务环境中，H5技术的应用通常是为了提升公共服务的质量和效率。事项场景分析可能涉及政府各部门提供的各类服务，如公民身份认证、行政审批、公共服务查询、缴费服务等。这些服务的线上化能够简化流程，提高公众...
- **初版发布日期**：1983年1月25日 - **后续修订包括了各种改进和新增内容**，例如：在1997年的D版中引入并规定了L2C信号中的改进时钟和星历（ICE）消息。 - **最近一次修订**（F版）于2011年9月21日发布，其中...
编写此文档的主要目的是为开发团队提供一个清晰的开发路线图，明确每个模块的功能、性能要求以及相互之间的接口关系，以便于团队成员协同工作，保证软件开发的质量和效率。 1.2 背景 ManilaOnline2.0是在软件工程...
在IT行业中，软件测试是确保产品质量的关键环节。在这个名为"5、项目测试文档1"的文档中，我们关注的...在实际开发中，这样的测试文档是确保软件质量的重要工具，有助于找出并修复潜在的问题，从而提高软件的整体质量。
测试规范是确保产品质量的重要环节，本规范主要针对QA在软件测试过程中的各项活动，旨在提高测试效率，降低产品风险。以下是对这些规范的详细解读： 一、需求评审 需求评审是测试流程的第一步，旨在确保测试人员能...
以下是对【质量管理体系建设思路.docx】文档中提及的知识点的详细解析： 1. **导入阶段**： - **质量体系策划**：按照PDCA（Plan-Do-Check-Act）模式，设立由高层领导参与的质量体系推进小组，负责制定计划、质量...
“新建发送1”可能是项目或者文档的起始部分，通常包含项目的介绍、目的和初版内容。“找BUG工具”可能是指除FindBugs之外的其他调试工具，如Eclipse的ErrorLens，IntelliJ IDEA的Inspections，或者是代码审查平台如...
3. **过程**：定义软件开发的流程、文档标准和质量管理措施。 #### 六、软件工程的目标 - 降低开发成本。 - 实现预期的功能和性能。 - 提高可移植性和维护性。 - 控制开发周期，确保按时交付。 #### 七、软件工程...
大连二期基站开通数据配置指导书（V1.0初版.doc 是一份详细的步骤指南，用于在大连地区第二阶段的基站建设与开通过程中进行必要的数据配置。这份文档旨在确保基站能够顺利接入网络，提供稳定可靠的通信服务。以下是...
例如，2004年9月1日的初版文档，之后在同年9月2日对阈值进行了修订等。这些信息有助于理解文档的演变过程及其改进之处。 4. **文档结构**：文档共有73页，包含了关于WMM系统互操作性的全面测试计划。这意味着文档...
**JAVA编码规范文档整合阿里巴巴Java开发规范手册** **1. 概览** 在软件开发过程中，遵循统一的编码规范是确保...这份文档通过不断的修订和完善，为Java开发者提供了一个全面的指导，帮助他们编写出更高质量的代码。
文档中提到了文档的历史版本，以及每个版本的日期、作者、状态、机密级别和修订ID，显示了其从初版到最终版本的演变过程。每一个版本的发布都经过了汽车行业SIG成员的高质量工作，并通过了正式评审。文档中提到的...
- **标准化设计**：完成设计任务书初版，制定建筑设计标准、石材深化设计标准、门窗深化设计标准等，以提高设计质量和效率。 - **心得分享**：在部门内部进行设计心得分享，普及建筑知识，提高团队的专业水平。 ###...
- **标准引用**：随着版本更新，引入了多个国家标准（如GB/T 25069-2010、GB/T 25069-2022等）和行业标准中的术语，提高了文档的专业性和权威性。 - **国际化**：提供了大量中英文对照的术语，便于国际交流。 ###...