iThink | 亢金元：码农也要会码字
日期：2017-09-22 17:09:40
剖析iPanel经典工作案例，深入浅出，提升职场技能so easy~
如何快速接手新工作？
关键在于工作交接文档
如何快速熟悉新领域？
关键在于大量查阅已有文档
◆ ◆ ◆ ◆ ◆
工作中的文档，对于码农们来说，特别是开发/软件文档，其重要性不言而喻。今天，亢哥就通过两个小案例，和我们聊聊：工作中文档梳理的重要性。
案例1：
一天小A收到某业务经理的邮件：2014年给G运营商做的项目X已竣工。但经查验，合同约定的相关技术资料不全，需两天内补齐，以免耽搁了收款事宜。”
小A迅速查看合同，居然足足有8份文档！他赶紧搜索SVN，迅速找到了5份。但仍缺少3份，其中一份文档需描述清楚当时项目进度计划和实际工作周期，但由于已过去2年多，当初参与该项目的同事已经记不清了。他只能到处查找邮件和任务系统收集整理，最终花了1天半的时间才完成，可还有2份文档在等着他。此时，他手头项目也因此出现了不同程度的延期。。。
亢哥点评
案例2：
某天，领导给鲜肉小B安排了个任务：策划一个小产品。任务要求：抓住用户痛点；周五输出相应的PRD文档给研发人员，并cc领导。小B听完一脸懵逼：PRD是个啥？领导顺便解释了下PRD就是所谓的“产品需求文档”，用于描述产品的功能规格和性能指标等。小B恍然大悟，欣然接受了这个任务。
接下来几天，小B积极了解市面上同类产品，进行使用体验和功能梳理。3天后觉得差不多了，就按照自己的理解写了一份PRD文档发送了出去。
很快，领导回复了小B，说看完文档，有以下几个疑问：
1、如果这个产品将来面世，它的卖点是什么？
2、有哪些用户场景，业务流程是什么样的？
3、产品的目标和版本计划是如何规划的？
小B看完回复内心不解：明明是按照要求写了一份prd，还花了那么多时间，这些问题我怎么知道呢？
亢哥点评
亢哥总结
在软件行业，文档的编制是整个产品或项目成功的基础。除了上述说的两点，文档还有以下作用：
a）管理依据：管理者需要通过文档了解项目进展、问题与风险、和预期目标等。如果文档有遗漏或内容过时，则失去跟踪和控制项目的重要依据；
b）任务之间联系的凭证：产品分析人员向设计人员提供产品需求规格文档；设计人员向开发人员提供设计文档…
c）质量保证：描述产品或工作验收的标准与期望；
d）培训与参考
e）产品维护支持
f）历史档案
亲爱的伙伴们，不知你是否也有过
因为文档缺失或者过时
而导致工作效率不佳/走弯路的情况？
不管现在情况如何，努力做好手头工作的梳理
输出文档，做个靠谱的队友吧~