文档应该怎样写啊？

realghost 2002-04-12 07:35:07

我再帮人做一个通讯录的小程序（用的是VB），在编码之前想写一个文档，可是不知道该怎么写，要写那些内容，各位高手能不能告诉我啊？最好有一个示范的文档。不胜感激！

...全文

50 1 打赏收藏转发到动态举报

写回复

1 条回复

切换为时间正序

请发表友善的回复…

发表回复

青润 2002-04-12

打赏
举报

回复

编码之前？你要写的是什么文档？是设计文档还是需求文档，或者是编码的指导文档，还是软件的使用说明书？

申请实用新型专利时可能需要填写的文档及填写实例。

给大家介绍一款数据库文档生成工具目前只支持mysql 主要是生成docx的客户有些时候需要数据库文档，为了方便，于是我就写了这个工具，通过数据库读取相关表数据，达到输出所有注释到文档中，大大提高了工作效率

80% 的文档都是无效的，所以多数情况下，程序员都不用写文档，原因如下：多数文档都是代码的点缀或者静态的记录已经实现的代码，懂代码的开发人员会直接看代码，不懂代码的开发人员压根不会看。写文档是一件要求极高的工作，就像测试驱动开发，在没有完成开发之前要理解它完成之后的样子。除非是逻辑复杂度极高的代码，否则都应该在实现过程中摸索和调整代码结构，这种效率反而更高。服务代码常变而...

软件需求获取过程一般都是要到具体的业务部门进行需求调研。那对我们需求获取的内容如何进行整理需求文档并和用户更好的再次沟通和确认呢？通过本人的工作经验，总结如下：首先按部门分类： 1、业务部门定位该部门主要负责哪些工作，他们希望通过系统来简化他哪方面的工作。就是弄清楚部门主要管理的工作和他们对系统的关注点。 2、业务流程图该部门负责...

今天，带你一起分析了为什么不爱写项目文档的原因，也解释了为什么写文档很重要。没时间写或者懒，不能成为不写文档的理由。对于重要的项目文档，就应该加入到日常的开发任务中，把写文档，摆在和设计、开发同等重要的位置。从某种角度来说，写不好文档，代码也很难写好。针对程序员不爱写项目文档的情况，我也提出了切实可行的写文档的方法。比如说不会写，就可以从模仿别人写的文档开始，然后从粗到细，不断迭代，配合一些图表，就可以写出不错的项目文档。

1,268

社区成员

28,283

社区内容

发帖

与我相关

我的任务

社区管理员

加入社区

近7日
近30日
至今

加载中

查看更多榜单

社区公告

暂无公告

试试用AI创作助手写篇文章吧

+ 用AI写文章