`

什么样的东西该写成文档?

阅读更多

   1) 如果写了,不会花很多精力;

   2) 如果不写,以后维护的时候效率会很低;

   3) 禁得住时间的考验。

 

    源代码注释,系统维护手册,一些checklist应该写。

    详细设计就不行了,依我看,这是最废的文档,如果不是外包。

 

分享到:
评论
1 楼 mingo 2008-12-22  
系统架构文档也应该写,写了之后
1、让架构者对即将产生的系统架构更清晰
2、让在这个架构下干活的人理解更容易

相关推荐

    Word文档直接转换专业的帮助文档

    这时,就需要将Word文档转换成专业的帮助文档格式。帮助文档通常具有固定的结构,如目录、索引、搜索功能,以及与软件界面紧密关联的链接。这些特性使得用户在使用软件时可以快速找到所需信息。 在这个过程中,...

    怎么写产品需求文档 .doc

    Visio 是一个老掉牙的工具,可以直接地把整个流程框束在文档上,不论开发怎样的系统,需求什么样的环境,都可以一一标明出来。 3. 把项目条目化,条理化,目录结构具体规定好 在编写产品需求文档时,需要把项目...

    富文本编辑器生成的含有图片的内容转换成word文档 java 后端下载

    对于base64编码的图片,我们需要先解码成字节数组,然后将其作为图片流插入到Word文档中。对于网络图片,我们需要先下载到服务器,然后再处理。 以下是一些关键步骤: 1. **解析富文本内容**:使用JSON库(如...

    怎样写出清晰的需求文档_肖哥1

    【怎样写出清晰的需求文档】 需求文档是产品开发过程中的核心文档,它决定了项目的走向和团队的理解。编写清晰、准确的需求文档对于确保项目成功至关重要。以下是一些撰写优质需求文档的关键点: 1. **目的明确**...

    PRD之道:活用Axure快速撰写轻便的需求文档.docx

    * 产品原则:通用性的规范,让所有人都知道应该遵从什么标准,什么要求,做成什么样。 * 功能结构:通俗一点的说法就是,“用图来描述”你现在想从哪里动刀子了,是要改动“个人资料”模块还是订单页面。 * 关键流程...

    JXL中文开发文档.pdf

    比如:1、创建或读取一个工作薄 Workbook,2、创建工作表 Sheet,3、创建标签 Label,4、填充数据,5、合并单元格,6、添加单元格的式样,7、设置单元格字体,8、将工作写成文件,9、行列的批量操作,10、获取单元格...

    你必须知道的495个C语言问题

    1.4 新的64位机上的64位类型是什么样的? 指针声明 1.5 这样的声明有什么问题?char*p1,p2;我在使用p2的时候报错了。 1.6 我想声明一个指针,并为它分配一些空间,但却不行。这样的代码有什么问题?char*p;*p=...

    尚硅谷Nosql文档资料redis

    - **读写分离:** 读操作由从库承担,写操作则由主库完成。 **3. 分表分库 + 水平拆分 + MySQL集群** - **分表:** 将一张大表分割成多个小表。 - **分库:** 根据业务逻辑将表分散到不同的数据库中。 - **水平...

    《你必须知道的495个C语言问题》

    1.4 新的64位机上的64位类型是什么样的? 3 指针声明 3 1.5 这样的声明有什么问题?char *p1, p2; 我在使用p2的时候报错了。 3 1.6 我想声明一个指针,并为它分配一些空间,但却不行。这样的代码有什么问题?...

    Doxygen简介及使用说明.pdf

    以一个类的注释为例,可以写成: ```cpp /** * @brief 类的简要说明 * @details 类的详细说明 */ class MyClass { public: int member1; ///注释member1 }; ``` 函数注释的示例: ```cpp /** * @brief 函数的...

    企业需要什么样的程序员,项目经理3年的总结

    【标题】:企业需要什么样的程序员,项目经理3年的总结 【正文】: 在当前竞争激烈的IT行业中,企业对程序员的需求不仅仅是技术能力的体现,更看重的是综合能力与职业素养。作为一个有着三年经验的项目经理,我...

    c语言代码的编辑仓库,测试使用.rar

    那我们需要一个什么样的文件呢?既然C语言代码是一些文字,那么Word文档行不行? 其实没那么复杂,由于C语言代码并不需要各种字体、段落格式。所以,可以更加简单一点。 在你需要保存文件的地方(我这里选择的是F...

    互联网新产品设计开发流程.doc

    产品经理需要把产品小心的交给项目经理,再由项目经理分解需求写成一个FSD(功能详细说明文档),这个文档是给开发人员看的,他们可以拿到这样的文档直接开始开发。 新产品设计开发流程需要产品经理具备战略规划、...

    自己写的简单的登录系统

    标题中的“自己写的简单的登录系统”表明这是一个个人开发的、用于用户登录验证的软件系统。在描述中提到“带有校验的,利用jquery美化页面”,这提示我们该系统包含前端验证功能,使用了jQuery库来增强用户体验,...

    3次B样条曲线是用c++写的!

    首先,我们要理解什么是B样条(B-Spline)。B样条是一种基于控制点的非均匀有理B样条(NURBS)的特殊形式,"非均匀"意味着控制点对曲线形状的影响随位置变化,"有理"则是指权重因子的存在,这使得曲线可以更好地模拟...

    五年级英语上册堂堂清.doc

    " 他是什么样的人? 3. 单项选择题:这部分涉及了对人物特性和身份的描述。例如: - (B) art teacher:艺术老师 - (B) young and thin:年轻且瘦 - (B) funny; him:有趣的;他(宾格) - (A) old man:老人 -...

    周考试题文档(4).docx

    无论工人们遇到什么样的困难,他们却能披荆斩棘...”中关联词使用不当,需要学生能识别并改正语病。 8. **新闻标题拟写**:训练学生概括新闻主要内容的能力,例如“神舟七号”发射计划的新闻,要求简洁明了地概括...

    VC++常用功能实例

    ◆如何在启动时阻止MDI应用程序创建一个新文档?◆ 33 ◆如何在多文档MFC程序中制作独立的File|New菜单?◆ 33 ◆如何检测视是否处于分割状态?◆ 34 ◆如何使程序保持极小状态?◆ 34 ◆如何确定当前进程实例是否为...

    VC++常用的共用函数100多页

    ◆如何在启动时阻止MDI应用程序创建一个新文档?◆ 33 ◆如何在多文档MFC程序中制作独立的File|New菜单?◆ 33 ◆如何检测视是否处于分割状态?◆ 34 ◆如何使程序保持极小状态?◆ 34 ◆如何确定当前进程实例是否为...

Global site tag (gtag.js) - Google Analytics